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