Fix readme
This commit is contained in:
parent
981503e153
commit
11558458ee
13
README.md
13
README.md
|
@ -3,10 +3,13 @@
|
||||||
## Description
|
## Description
|
||||||
`kls` is a cli tool based on `kubectl` for managing kubernetes cluster resources.
|
`kls` is a cli tool based on `kubectl` for managing kubernetes cluster resources.
|
||||||
Inspired by `lf` and `ranger` file managers, written in python.
|
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.
|
|
||||||
|
It is lightweight (~250 lines of code) and easy to customize.
|
||||||
|
Supports mouse navigation as well as keyboard navigation.
|
||||||
|
|
||||||
## Key bindings
|
## Key bindings
|
||||||
For kubectl (You can customize these bindings or add extra bindings in `KEY_BINDINGS` variable of `kls` in a row #4):
|
### For kubectl
|
||||||
|
You can customize these bindings or add extra bindings in `KEY_BINDINGS` variable of `kls` in a row #4:
|
||||||
- `1` or `Enter` - get yaml of resource
|
- `1` or `Enter` - get yaml of resource
|
||||||
- `2` - describe resource
|
- `2` - describe resource
|
||||||
- `3` - edit resource
|
- `3` - edit resource
|
||||||
|
@ -15,9 +18,11 @@ For kubectl (You can customize these bindings or add extra bindings in `KEY_BIND
|
||||||
- `6` - network debug of pod (with nicolaka/netshoot container attached)
|
- `6` - network debug of pod (with nicolaka/netshoot container attached)
|
||||||
- `delete` - delete resource
|
- `delete` - delete resource
|
||||||
|
|
||||||
Other:
|
### Other:
|
||||||
|
- letters - enter filter mode and apply filter
|
||||||
- `Escape` - exit filter mode or `kls` itself
|
- `Escape` - exit filter mode or `kls` itself
|
||||||
- `TAB`, arrow keys - navigation
|
- `Backspace` - remove letter from filter
|
||||||
|
- `TAB`, arrow keys, `PgUp`, `PgDn`, `Home`, `End` - navigation
|
||||||
|
|
||||||
![kls in action](./images/kls.gif)
|
![kls in action](./images/kls.gif)
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue