kubectx + kubens: Power tools for kubectl

This repository provides both kubectx and kubens tools.Install →

�� �� NEWS: With v0.9.0 kubectx and kubens are now rewritten in Go.(Don't worry, our lovely bash versions are still available!) Please testthis new Go binaries by downloading them fromReleases →

kubectx helps you switch between clusters back and forth:

kubens helps you switch between Kubernetes namespaces smoothly:

kubectx(1)

kubectx is a utility to manage and switch between kubectl(1) contexts.

USAGE:
  kubectx                   : list the contexts
  kubectx <NAME>            : switch to context <NAME>
  kubectx -                 : switch to the previous context
  kubectx -c, --current     : show the current context name
  kubectx <NEW_NAME>=<NAME> : rename context <NAME> to <NEW_NAME>
  kubectx <NEW_NAME>=.      : rename current-context to <NEW_NAME>
  kubectx -d <NAME>         : delete context <NAME> ('.' for current-context)
                              (this command won't delete the user/cluster entry
                              that is used by the context)
  kubectx -u, --unset       : unset the current context

Usage

$ kubectx minikube
Switched to context "minikube".

$ kubectx -
Switched to context "oregon".

$ kubectx -
Switched to context "minikube".

$ kubectx dublin=gke_ahmetb_europe-west1-b_dublin
Context "dublin" set.
Aliased "gke_ahmetb_europe-west1-b_dublin" as "dublin".

kubectx supports Tab completion on bash/zsh/fish shells to help withlong context names. You don't have to remember full context names anymore.

kubens(1)

kubens is a utility to switch between Kubernetes namespaces.

USAGE:
  kubens                    : list the namespaces
  kubens <NAME>             : change the active namespace
  kubens -                  : switch to the previous namespace
  kubens -c, --current      : show the current namespace

Usage

$ kubens kube-system
Context "test" set.
Active namespace is "kube-system".

$ kubens -
Context "test" set.
Active namespace is "default".

kubens also supports Tab completion on bash/zsh/fish shells.

Installation

�� �� NEWS: With v0.9.0 kubectx and kubens are now rewritten in Go.(Don't worry, our lovely bash versions are still available!) Please testthis new Go binaries by downloading them fromReleases →

There are several installation options:

• As kubectl plugins (macOS/Linux)
• macOS
  • Homebrew (recommended)
  • MacPorts
• Linux
  • Debian
  • Arch Linux
  • Homebrew
  • Manual installation

Kubectl Plugins (macOS and Linux)

You can install and use Krew kubectlplugin manager to get kubectx and kubens. NOTE: This will not installshell completion scripts, if you want those, choose another installation methodbelow.

kubectl krew install ctx
kubectl krew install ns

After installing, the tools will be available as kubectl ctx and kubectl ns.

macOS

Homebrew

�� If you use Homebrew you can install like this:

brew install kubectx

This command will set up bash/zsh/fish completion scripts automatically.

• If you like to add context/namespace info to your shell prompt ($PS1),I recommend trying out kube-ps1.

MacPorts

If you use MacPorts you can install like this:

sudo port install kubectx

Linux

Debian

sudo apt install kubectx

Newer versions might be available on repos likeDebian Buster (testing),Sid (unstable)(if you are unfamiliar with the Debian release process and how to enabletesting/unstable repos, check out theDebian Wiki):

Arch Linux

Available as official Arch Linux package. Install it via:

sudo pacman -S kubectx

Homebrew

�� If you use Homebrew you can install like this:

brew install kubectx

This command will set up bash/zsh/fish completion scripts automatically.

• If you like to add context/namespace info to your shell prompt ($PS1),I recommend trying out kube-ps1.

Manual

Since kubectx/kubens are written in Bash, you should be able to installthem to any POSIX environment that has Bash installed.

• Download the kubectx, and kubens scripts.
• Either:
  • save them all to somewhere in your PATH,
  • or save them to a directory, then create symlinks to kubectx/kubens fromsomewhere in your PATH, like /usr/local/bin
• Make kubectx and kubens executable (chmod +x ...)
• Install bash/zsh/fish completion scripts.
  • For zsh:The completion scripts have to be in a path that belongs to $fpath. Either link or copy them to an existing folder.If using oh-my-zsh you can do as follows:

    mkdir -p ~/.oh-my-zsh/completions
    chmod -R 755 ~/.oh-my-zsh/completions
    ln -s /opt/kubectx/completion/kubectx.zsh ~/.oh-my-zsh/completions/_kubectx.zsh
    ln -s /opt/kubectx/completion/kubens.zsh ~/.oh-my-zsh/completions/_kubens.zsh

    Note that the leading underscore seems to be a convention. If completion doesn't work, add autoload -U compinit && compinit to your .zshrc (similar to zsh-completions).If not using oh-my-zsh, you could link to /usr/share/zsh/functions/Completion (might require sudo), depending on the $fpath of your zsh installation.In case of error, calling compaudit might help.
  • For bash:

    git clone https://github.com/ahmetb/kubectx.git ~/.kubectx
    COMPDIR=$(pkg-config --variable=completionsdir bash-completion)
    ln -sf ~/.kubectx/completion/kubens.bash $COMPDIR/kubens
    ln -sf ~/.kubectx/completion/kubectx.bash $COMPDIR/kubectx
    cat << FOE >> ~/.bashrc
    
    
    #kubectx and kubens
    export PATH=~/.kubectx:\$PATH
    FOE

  • For fish:

    mkdir -p ~/.config/fish/completions
    ln -s /opt/kubectx/completion/kubectx.fish ~/.config/fish/completions/
    ln -s /opt/kubectx/completion/kubens.fish ~/.config/fish/completions/

Example installation steps:

sudo git clone https://github.com/ahmetb/kubectx /opt/kubectx
sudo ln -s /opt/kubectx/kubectx /usr/local/bin/kubectx
sudo ln -s /opt/kubectx/kubens /usr/local/bin/kubens

Interactive mode

If you want kubectx and kubens commands to present you an interactive menuwith fuzzy searching, you just need to installfzf in your PATH.

If you have fzf installed, but want to opt out of using this feature, set the environment variable KUBECTX_IGNORE_FZF=1.

If you want to keep fzf interactive mode but need the default behavior of the command, you can do it using Unix composability:

kubectx | cat

Customizing colors

If you like to customize the colors indicating the current namespace or context, set the environment variables KUBECTX_CURRENT_FGCOLOR and KUBECTX_CURRENT_BGCOLOR (refer color codes here):

export KUBECTX_CURRENT_FGCOLOR=$(tput setaf 6) # blue text
export KUBECTX_CURRENT_BGCOLOR=$(tput setab 7) # white background

Colors in the output can be disabled by setting theNO_COLOR environment variable.

Users

If you liked kubectx, you may like my kubectl-aliases project, too.

Disclaimer: This is not an official Google product.

Stargazers over time