Aliases

AutoSuggestions

K9s command mode supports autosuggestions. Suggestions are based on supported Kubernetes resource in singular/plural as well as short names and command aliases as describe below. The command mode supports the following keys:

Key	Description
⬆️ ⬇️	Navigate up or down thru the suggestions
`Ctrl-w`, `Ctrl-u`	Clear out the command
`Tab`, `Ctrl-f`, ➡️	Accept the suggestion

Aliases

In K9s, you can define your very own command aliases (short-names) to access your resources. In your $XDG_CONFIG_HOME/k9s define a file called alias.yml. A K9s alias defines pairs of alias:gvr. A gvr (Group/Version/Resource) represents a fully qualified Kubernetes resource identifier. Here is an example of an alias file:

Example

Using this alias file, you can now type pp/crb to list pods or ClusterRoleBindings respectively.

# $XDG_CONFIG_HOME/k9s/alias.yml
alias:
  # Use pp as an alias for Pod
  pp: v1/pods

  # Use crb as an alias for ClusterRoleBinding
  crb: rbac.authorization.k8s.io/v1/clusterrolebindings

  # Use cr as an alias for ClusterRole
  cr: rbac.authorization.k8s.io/v1/clusterroles

  # Use dep as an alias for Deployments
  dep: apps/v1/deployments

  # Use fred as an alias for CRD Frederick
  fred: acme.io/v1alpha1/fredericks

Back