kops/docs/cli/kops_completion_zsh.md

58 lines
1.5 KiB
Markdown

<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code (under cmd/kops) -->
## kops completion zsh
Generate the autocompletion script for zsh
### Synopsis
Generate the autocompletion script for the zsh shell.
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
To load completions in your current shell session:
source <(kops completion zsh); compdef _kops kops
To load completions for every new session, execute once:
#### Linux:
kops completion zsh > "${fpath[1]}/_kops"
#### macOS:
kops completion zsh > $(brew --prefix)/share/zsh/site-functions/_kops
You will need to start a new shell for this setup to take effect.
```
kops completion zsh [flags]
```
### Options
```
-h, --help help for zsh
--no-descriptions disable completion descriptions
```
### Options inherited from parent commands
```
--config string yaml config file (default is $HOME/.kops.yaml)
--name string Name of cluster. Overrides KOPS_CLUSTER_NAME environment variable
--state string Location of state storage (kops 'config' file). Overrides KOPS_STATE_STORE environment variable
-v, --v Level number for the log level verbosity
```
### SEE ALSO
* [kops completion](kops_completion.md) - Generate the autocompletion script for the specified shell