digitalstudium
/
kls
1
0
Fork 0
Code Pull Requests Releases Activity
Tool for managing kubernetes cluster resources. Inspired by lf and ranger file managers
155 Commits 3 Branches 0 Tags 5 MiB
Python 100%
Go to file
Digital Studium 32c2118eca Renaming 2025-01-02 17:51:13 +03:00
diagrams Refactoring 2024-12-31 23:10:03 +03:00
images Change image 2024-04-19 09:15:13 +03:00
tests Renaming 2025-01-02 17:51: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 Refactoring 2024-12-31 23:10:03 +03:00
kls Renaming 2025-01-02 17:51:13 +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 #69).

Key bindings

For kubectl

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

  • 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)
  • Ctrl+a - Access logs of istio sidecar
  • Ctrl+p - exec into istio-Proxy sidecar
  • Ctrl+r - Reveal base64 secret values
  • delete - delete resource

Other:

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

kls in action

Dependencies

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

Installation

Install batcat and other dependencies:

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