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 common command line arguments from k9s (https://github.com/derailed/k9s).
  17
  18 > `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.
  19
  20 ### Preflight check
  21
  22 K9s uses 256 colors terminal mode. On `Nix system make sure TERM is set accordingly.
  23
  24 ```bash
  25 export TERM=xterm-256color
  26 ```
  27
  28 To run k9s:
  29 ```bash
  30 k9s
  31 ```
  32
  33 ### Command line arguments
  34
  35 List all available CLI options
  36 ```bash
  37 k9s help
  38 ```
  39
  40 To get info about K9s runtime (logs, configs, etc..)
  41 ```bash
  42 k9s info
  43 ```
  44
  45 To run K9s in a given namespace
  46 ```bash
  47 k9s -n mycoolns
  48 ```
  49
  50 Start K9s in an existing KubeConfig context
  51 ```bash
  52 k9s --context coolCtx
  53 ```
  54
  55 Start K9s in readonly mode - with all cluster modification commands disabled
  56 ```bash
  57 k9s --readonly
  58 ```