kls/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 (~250 lines of code) and easy to customize. Supports mouse navigation as well as keyboard navigation.

Key bindings

For kubectl

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

• 1 or Enter - get yaml of resource
• 2 - describe resource
• 3 - edit resource
• 4 - logs of pod
• 5 - exec to pod
• 6 - network debug of pod (with nicolaka/netshoot container attached)
• delete - delete resource

Other:

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

Dependencies

• python3
• kubectl
• bat

Installation

Install batcat:

sudo apt install bat -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