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 The information in this section is a copy of the preflight requirements and
  17 common command line arguments from k9s (https://github.com/derailed/k9s).
  18
  19 > `k9s` aim is to make it easier to navigate, observe and manage your
  20 > applications in the wild. K9s continually watches Kubernetes for changes and
  21 > offers subsequent commands to interact with your observed resources.
  22
  23 ### Preflight check
  24
  25 K9s uses 256 colors terminal mode. On `Nix system make sure TERM is set
  26 accordingly.
  27
  28 ```bash
  29 export TERM=xterm-256color
  30 ```
  31
  32 To run k9s:
  33
  34 ```bash
  35 k9s
  36 ```
  37
  38 ### Command line arguments
  39
  40 List all available CLI options
  41
  42 ```bash
  43 k9s help
  44 ```
  45
  46 To get info about K9s runtime (logs, configs, etc..)
  47
  48 ```bash
  49 k9s info
  50 ```
  51
  52 To run K9s in a given namespace
  53
  54 ```bash
  55 k9s -n mycoolns
  56 ```
  57
  58 Start K9s in an existing KubeConfig context
  59
  60 ```bash
  61 k9s --context coolCtx
  62 ```
  63
  64 Start K9s in readonly mode - with all cluster modification commands disabled
  65
  66 ```bash
  67 k9s --readonly
  68 ```