Docs Self-Managed Reference rpk Commands rpk generate rpk generate shell-completion You are viewing the Self-Managed v24.3 beta documentation. We welcome your feedback at the Redpanda Community Slack #beta-feedback channel. To view the latest available version of the docs, see v24.2. 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, run this once: rpk generate shell-completion zsh > "${fpath[1]}/_rpk" You can also place that command in your ~/.zshrc to ensure that when you update rpk, you update autocompletion. If you initially require sudo to edit that file, you can chmod it to be world writeable, after which you will always be able to update it from ~/.zshrc. If shell completion is not already enabled in your zsh environment, also add the following to your ~/.zshrc: autoload -U compinit; compinit Fish To enable autocompletion in any fish session, run: rpk generate shell-completion fish > ~/.config/fish/completions/rpk.fish Usage rpk generate shell-completion [flags] Flags Value Type Description -h, --help - Help for shell-completion. --config string Redpanda or rpk config file; default search paths are /var/lib/redpanda/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml. -X, --config-opt stringArray Override rpk configuration settings. See rpk -X or execute rpk -X help for inline detail or rpk -X list for terser detail. --profile string Profile to use. See rpk profile for more details. -v, --verbose - Enable verbose logging. Back to top × Simple online edits For simple changes, such as fixing a typo, you can edit the content directly on GitHub. Edit on GitHub Or, open an issue to let us know about something that you want us to change. Open an issue Contribution guide For extensive content updates, or if you prefer to work locally, read our contribution guide . Was this helpful? thumb_up thumb_down group Ask in the community mail Share your feedback group_add Make a contribution rpk generate prometheus-config rpk group