Feb 21, 2024: Announcing Linkerd 2.15 with support for VM workloads, native sidecars, and SPIFFE! Read more »


This is not the latest version of Linkerd!
This documentation is for an older version of Linkerd. You may want the Linkerd 2.15 (current) documentation instead.

completion

Output shell completion code for the specified shell (bash, zsh or fish).

Examples

# bash <= 3.2:
# To load shell completion into your current shell session
source /dev/stdin <<< "$(linkerd completion bash)"

# bash >= 4.0:
source <(linkerd completion bash)

# To load shell completion for every shell session
# bash <= 3.2 on osx:
brew install bash-completion # ensure you have bash-completion 1.3+
linkerd completion bash > $(brew --prefix)/etc/bash_completion.d/linkerd

# bash >= 4.0 on osx:
brew install bash-completion@2
linkerd completion bash > $(brew --prefix)/etc/bash_completion.d/linkerd

# bash >= 4.0 on linux:
linkerd completion bash > /etc/bash_completion.d/linkerd

# You will need to start a new shell for this setup to take effect.

# zsh:
# If shell completion is not already enabled in your environment you will need
# to enable it.  You can execute the following once:

echo "autoload -U compinit && compinit" >> ~/.zshrc

# create a linkerd 'plugins' folder and add it to your $fpath
mkdir $ZSH/plugins/linkerd && echo "fpath=($ZSH/plugins/linkerd $fpath)" >> ~/.zshrc

# To load completions for each session, execute once:
linkerd completion zsh > "${fpath[1]}/_linkerd" && exec $SHELL

# You will need to start a new shell for this setup to take effect.

# fish:
linkerd completion fish | source

# To load fish shell completions for each session, execute once:
linkerd completion fish > ~/.config/fish/completions/linkerd.fish