Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.k9s.enable

Whether to enable k9s - Kubernetes CLI To Manage Your Clusters In Style.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.k9s.package

The k9s package to use.

Type: null or package

Default:

pkgs.k9s

Declared by:

programs.k9s.aliases

Aliases written to $XDG_CONFIG_HOME/k9s/aliases.yaml (linux) or Library/Application Support/k9s/aliases.yaml (darwin). See https://k9scli.io/topics/aliases/ for supported values.

Type: YAML 1.1 value

Default:

{ }

Example:

{
  # Use pp as an alias for Pod
  pp = "v1/pods";
}

Declared by:

programs.k9s.hotKeys

Hotkeys written to $XDG_CONFIG_HOME/k9s/hotkeys.yaml (linux) or Library/Application Support/k9s/hotkeys.yaml (darwin). See https://k9scli.io/topics/hotkeys/ for supported values.

Type: YAML 1.1 value

Default:

{ }

Example:

{
  shift-0 = {
    command = "pods";
    description = "Viewing pods";
    shortCut = "Shift-0";
  };
}

Declared by:

programs.k9s.plugins

Plugins written to $XDG_CONFIG_HOME/k9s/plugins.yaml (linux) or Library/Application Support/k9s/plugins.yaml (darwin). See https://k9scli.io/topics/plugins/ for supported values.

Type: YAML 1.1 value

Default:

{ }

Example:

{
  # Defines a plugin to provide a `ctrl-l` shortcut to
  # tail the logs while in pod view.
  fred = {
    shortCut = "Ctrl-L";
    description = "Pod logs";
    scopes = [ "po" ];
    command = "kubectl";
    background = false;
    args = [
      "logs"
      "-f"
      "$NAME"
      "-n"
      "$NAMESPACE"
      "--context"
      "$CLUSTER"
    ];
  };
}

Declared by:

programs.k9s.settings

Configuration written to $XDG_CONFIG_HOME/k9s/config.yaml (linux) or Library/Application Support/k9s/config.yaml (darwin), See https://k9scli.io/topics/config/ for supported values.

Type: YAML 1.1 value

Default:

{ }

Example:

k9s = {
  refreshRate = 2;
};

Declared by:

programs.k9s.skins

Skin files written to $XDG_CONFIG_HOME/k9s/skins/ (linux) or Library/Application Support/k9s/skins/ (darwin). See https://k9scli.io/topics/skins/ for supported values.

Type: attribute set of (YAML 1.1 value or absolute path)

Default:

{ }

Example:

{
  my_blue_skin = {
    k9s = {
      body = {
        fgColor = "dodgerblue";
      };
    };
  };
  my_red_skin = ./red_skin.yaml;
}

Declared by:

programs.k9s.views

Resource column views written to $XDG_CONFIG_HOME/k9s/views.yaml (linux) or Library/Application Support/k9s/views.yaml (darwin). See https://k9scli.io/topics/columns/ for supported values.

Type: YAML 1.1 value

Default:

{ }

Example:

{
  "v1/pods" = {
    columns = [
      "AGE"
      "NAMESPACE"
      "NAME"
      "IP"
      "NODE"
      "STATUS"
      "READY"
    ];
  };
}

Declared by: