clusterctl completion command outputs shell completion code for the
specified shell (bash or zsh). The shell code must be evaluated to provide
interactive completion of clusterctl commands. This can be done by sourcing it
To install it on macOS use Homebrew:
$ brew install bash-completion
Once installed, bash_completion must be evaluated. This can be done by adding
the following line to the
[[ -r "$(brew --prefix)/etc/profile.d/bash_completion.sh" ]] && . "$(brew --prefix)/etc/profile.d/bash_completion.sh"
If bash-completion is not installed on Linux, please install the ‘bash-completion’ package via your distribution’s package manager.
You now have to ensure that the clusterctl completion script gets sourced in all your shell sessions. There are multiple ways to achieve this:
- Source the completion script in your
source <(clusterctl completion bash)
- Add the completion script to the /usr/local/etc/bash_completion.d directory:
clusterctl completion bash >/usr/local/etc/bash_completion.d/clusterctl
The clusterctl completion script for Zsh can be generated with the command
clusterctl completion zsh. Sourcing the completion script in your shell
enables clusterctl autocompletion.
To do so in all your shell sessions, add the following to your
source <(clusterctl completion zsh)
After reloading your shell, clusterctl autocompletion should be working.
If you get an error like
complete:13: command not found: compdef, then add
the following to the beginning of your
autoload -Uz compinit compinit