kls/README.md

30 lines
787 B
Markdown

# KLS
## Description
`kls` is a cli tool for managing kubernetes cluster resources. Inspired by `lf` and `ranger` file managers.
It is lightweight and easy to customize
## Key bindings for kubectl
- `1` - get yaml of resource
- `2` - describe resource
- `3` - edit resource
- `4` - logs of pod
You can customize these bindings or add extra bindings in `KEY_BINDINGS` variable of `kls` (in a row #4).
Also you can add additional columns for different api resources in `EXTRA_COLUMNS` variable (in a row #11).
![kls in action](./images/kls.gif)
## Dependencies
- `python3`
- `kubectl`
- `batcat`
## Installation
Download latest `kls`:
```
curl -O "https://git.digitalstudium.com/digitalstudium/kls/raw/branch/main/kls"
```
Then install it:
```
sudo install ./kls /usr/local/bin/
```