rpk generate shell-completion
Shell completion can help autocomplete rpk
commands when you press tab.
Bash
Bash autocompletion relies on the bash-completion package. You can test if you
have this by running type \_init_completion
, if you do not, you can install
the package through your package manager.
If you have bash-completion installed, and the command still fails, you likely
need to add the following line to your ~/.bashrc
:
source /usr/share/bash-completion/bash_completion
To ensure autocompletion of rpk
exists in all shell sessions, add the following
to your ~/.bashrc
:
command -v rpk >/dev/null && . <(rpk generate shell-completion bash)
Alternatively, to globally enable rpk
completion, you can run the following:
rpk generate shell-completion bash > /etc/bash_completion.d/rpk
Zsh
To enable autocompletion in any zsh session for any user, follow these steps:
Determine which directory in your $fpath
to use to store the completion file.
You can inspect your fpath
by running:
echo $fpath
Choose one of the directories listed. For example, if /usr/local/share/zsh/site-functions
is present in your fpath
, you can place the _rpk
completion file there:
rpk generate shell-completion zsh > /usr/local/share/zsh/site-functions/_rpk
If the directory you chose is not already in fpath
, add it to your .zshrc
:
fpath+=(/usr/local/share/zsh/site-functions)
Finally, ensure that compinit
is run. Add (or verify) the following in your .zshrc
:
autoload -U compinit && compinit
After restarting your shell, rpk
completion should be active.
Fish
To enable autocompletion in any fish
session, run:
rpk generate shell-completion fish > ~/.config/fish/completions/rpk.fish
Flags
Value | Type | Description |
---|---|---|
|
- |
Help for shell-completion. |
|
string |
Redpanda or |
|
stringArray |
Override |
|
string |
Profile to use. See |
|
- |
Enable verbose logging. |