k9s/README.md

   1 ---
   2 title: K9s
   3 homepage: https://github.com/derailed/k9s
   4 tagline: |
   5   K9s provides a terminal UI to interact with your Kubernetes clusters
   6 ---
   7
   8 ### Updating `k9s`
   9
  10 `webi k9s@stable`
  11
  12 Use the `@beta` tag for pre-releases.
  13
  14 ## Cheat Sheet
  15
  16 > `k9s` aim is to make it easier to navigate, observe and manage your applications in the wild. K9s continually watches Kubernetes for changes and offers subsequent commands to interact with your observed resources.
  17
  18 ### Preflight check
  19
  20 K9s uses 256 colors terminal mode. On `Nix system make sure TERM is set accordingly.
  21
  22 ```bash
  23 export TERM=xterm-256color
  24 ```
  25
  26 To run k9s:
  27 ```bash
  28 k9s
  29 ```
  30
  31 ### Command line arguments
  32
  33 List all available CLI options
  34 ```bash
  35 k9s help
  36 ```
  37
  38 To get info about K9s runtime (logs, configs, etc..)
  39 ```bash
  40 k9s info
  41 ```
  42
  43 To run K9s in a given namespace
  44 ```bash
  45 k9s -n mycoolns
  46 ```
  47
  48 Start K9s in an existing KubeConfig context
  49 ```bash
  50 k9s --context coolCtx
  51 ```
  52
  53 Start K9s in readonly mode - with all cluster modification commands disabled
  54 ```bash
  55 k9s --readonly
  56 ```