From 11558458ee6cadd601d5c01fcadfc7653a499034 Mon Sep 17 00:00:00 2001 From: Digital Studium Date: Sat, 4 May 2024 13:22:23 +0300 Subject: [PATCH] Fix readme --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1fcbf00..8f30a78 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,13 @@ ## 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. + +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 #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 - `2` - describe 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) - `delete` - delete resource -Other: +### Other: +- letters - enter filter mode and apply filter - `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)