Difference between revisions of "Kubectl completion"
Jump to navigation
Jump to search
(Created page with "<pre> kubectl completion -h Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kubectl c...") |
|||
Line 1: | Line 1: | ||
− | + | ||
− | kubectl completion -h | + | kubectl completion -h |
− | Output shell completion code for the specified shell (bash or zsh). The shell | + | Output shell completion code for the specified shell (bash or zsh). The shell |
− | code must be evaluated to provide interactive completion of kubectl commands. | + | code must be evaluated to provide interactive completion of kubectl commands. |
− | This can be done by sourcing it from the .bash_profile. | + | This can be done by sourcing it from the .bash_profile. |
Detailed instructions on how to do this are available here: | Detailed instructions on how to do this are available here: | ||
− | https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion | + | https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion |
− | + | ||
− | + | Note for [[zsh]] users: [1] zsh completions are only supported in versions of zsh | |
− | >= 5.2 | + | >= 5.2 |
+ | <pre> | ||
Examples: | Examples: | ||
# Installing bash completion on macOS using homebrew | # Installing bash completion on macOS using homebrew |
Revision as of 10:17, 18 July 2021
kubectl completion -h Output shell completion code for the specified shell (bash or zsh). The shell code must be evaluated to provide interactive completion of kubectl commands. This can be done by sourcing it from the .bash_profile.
Detailed instructions on how to do this are available here: https://kubernetes.io/docs/tasks/tools/install-kubectl/#enabling-shell-autocompletion Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2
Examples: # Installing bash completion on macOS using homebrew ## If running Bash 3.2 included with macOS brew install bash-completion ## or, if running Bash 4.1+ brew install bash-completion@2 ## If kubectl is installed via homebrew, this should start working immediately. ## If you've installed via other means, you may need add the completion to your completion directory kubectl completion bash > $(brew --prefix)/etc/bash_completion.d/kubectl # Installing bash completion on Linux ## If bash-completion is not installed on Linux, please install the 'bash-completion' package ## via your distribution's package manager. ## Load the kubectl completion code for bash into the current shell source <(kubectl completion bash) ## Write bash completion code to a file and source it from .bash_profile kubectl completion bash > ~/.kube/completion.bash.inc printf " # Kubectl shell completion source '$HOME/.kube/completion.bash.inc' " >> $HOME/.bash_profile source $HOME/.bash_profile # Load the kubectl completion code for zsh[1] into the current shell source <(kubectl completion zsh) # Set the kubectl completion code for zsh[1] to autoload on startup kubectl completion zsh > "${fpath[1]}/_kubectl" Usage: kubectl completion SHELL [options] Use "kubectl options" for a list of global command-line options (applies to all commands).
See also
kubectl
: [cp | config | create
|delete
|edit | explain |
apply
|exec
|get
|set
|drain | uncordon | rolling-update
|rollout
|logs
|run
|auth
|label | annotate
|version
|top
|diff
|debug
|replace
|describe
|port-forward | proxy
|scale
|rollout
|api-resources
| expose deployment | expose | patch | attach | get endpoints | ~/.kube/config | kubectl logs --help | kubectl --help, kubectl-convert, kubectl autoscale, kubectl.kubernetes.io- Autocompletion (Bash),
complete
,kubectl completion
Advertising: