Tool for managing kubernetes cluster resources. Inspired by lf and ranger file managers

Go to file

Digital Studium f1be42ed02 Add new key bindings and types annotations		2024-12-21 09:14:02 +03:00
images	Change image	2024-04-19 09:15:13 +03:00
.gitignore	Add unit tests	2024-05-04 13:15:37 +03:00
LICENSE	Add license	2024-04-07 22:56:19 +03:00
README.md	Add new key bindings and types annotations	2024-12-21 09:14:02 +03:00
kls	Add new key bindings and types annotations	2024-12-21 09:14:02 +03:00
tests.py	Beautify code a bit	2024-05-10 19:34:02 +03:00

README.md

KLS

Description

kls is a cli tool based on kubectl for managing kubernetes cluster resources. Inspired by lf and ranger file managers, written in python.

It is lightweight (~400 lines of code) and easy to customize. Supports keyboard navigation and mouse navigation could be enabled (set MOUSE_ENABLED=True in a line #64).

Key bindings

For kubectl

You can customize these bindings or add extra bindings in KEY_BINDINGS variable of kls in a line #11:

Ctrl+y - get yaml of resource
Ctrl+d - describe resource
Ctrl+e - edit resource
Ctrl+l - logs of pod
Ctrl+x - exec into pod
Ctrl+n - network debug of pod (with nicolaka/netshoot container attached)
delete - delete resource
Ctrl+a - access logs of istio sidecar
Ctrl+p - exec into istio sidecar
Ctrl+r - reveal base64 secret values
Ctrl+x - exec into pod

Other:

/ - enter filter mode
Escape - exit filter mode or kls itself
Backspace - remove letter from filter
TAB, arrow keys, PgUp, PgDn, Home, End - navigation

Dependencies

python3
kubectl
bat - yaml viewer
lnav - log viewer
yq - yaml manipulation

Installation

Install batcat:

sudo apt install bat lnav yq -y

Download and install the latest kls:

curl -O "https://git.digitalstudium.com/digitalstudium/kls/raw/branch/main/kls" && sudo install ./kls /usr/local/bin/ && rm -f ./kls