Update CLI docs

This commit is contained in:
Ole Markus With 2022-04-10 10:28:37 +02:00
parent 90024ac4fc
commit c49b27350b
6 changed files with 40 additions and 33 deletions

2
docs/cli/kops.md generated
View File

@ -37,7 +37,7 @@ kOps is Kubernetes Operations.
### SEE ALSO
* [kops completion](kops_completion.md) - generate the autocompletion script for the specified shell
* [kops completion](kops_completion.md) - Generate the autocompletion script for the specified shell
* [kops create](kops_create.md) - Create a resource by command line, filename or stdin.
* [kops delete](kops_delete.md) - Delete clusters, instancegroups, instances, and secrets.
* [kops distrust](kops_distrust.md) - Distrust keypairs.

View File

@ -3,11 +3,10 @@
## kops completion
generate the autocompletion script for the specified shell
Generate the autocompletion script for the specified shell
### Synopsis
Generate the autocompletion script for kops for the specified shell.
See each sub-command's help for details on how to use the generated script.
@ -42,8 +41,8 @@ See each sub-command's help for details on how to use the generated script.
### SEE ALSO
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops completion bash](kops_completion_bash.md) - generate the autocompletion script for bash
* [kops completion fish](kops_completion_fish.md) - generate the autocompletion script for fish
* [kops completion powershell](kops_completion_powershell.md) - generate the autocompletion script for powershell
* [kops completion zsh](kops_completion_zsh.md) - generate the autocompletion script for zsh
* [kops completion bash](kops_completion_bash.md) - Generate the autocompletion script for bash
* [kops completion fish](kops_completion_fish.md) - Generate the autocompletion script for fish
* [kops completion powershell](kops_completion_powershell.md) - Generate the autocompletion script for powershell
* [kops completion zsh](kops_completion_zsh.md) - Generate the autocompletion script for zsh

View File

@ -3,27 +3,31 @@
## kops completion bash
generate the autocompletion script for bash
Generate the autocompletion script for bash
### Synopsis
Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
$ source <(kops completion bash)
source <(kops completion bash)
To load completions for every new session, execute once:
Linux:
$ kops completion bash > /etc/bash_completion.d/kops
MacOS:
$ kops completion bash > /usr/local/etc/bash_completion.d/kops
#### Linux:
kops completion bash > /etc/bash_completion.d/kops
#### macOS:
kops completion bash > /usr/local/etc/bash_completion.d/kops
You will need to start a new shell for this setup to take effect.
```
kops completion bash
@ -59,5 +63,5 @@ kops completion bash
### SEE ALSO
* [kops completion](kops_completion.md) - generate the autocompletion script for the specified shell
* [kops completion](kops_completion.md) - Generate the autocompletion script for the specified shell

View File

@ -3,18 +3,19 @@
## kops completion fish
generate the autocompletion script for fish
Generate the autocompletion script for fish
### Synopsis
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
$ kops completion fish | source
kops completion fish | source
To load completions for every new session, execute once:
$ kops completion fish > ~/.config/fish/completions/kops.fish
kops completion fish > ~/.config/fish/completions/kops.fish
You will need to start a new shell for this setup to take effect.
@ -53,5 +54,5 @@ kops completion fish [flags]
### SEE ALSO
* [kops completion](kops_completion.md) - generate the autocompletion script for the specified shell
* [kops completion](kops_completion.md) - Generate the autocompletion script for the specified shell

View File

@ -3,15 +3,15 @@
## kops completion powershell
generate the autocompletion script for powershell
Generate the autocompletion script for powershell
### Synopsis
Generate the autocompletion script for powershell.
To load completions in your current shell session:
PS C:\> kops completion powershell | Out-String | Invoke-Expression
kops completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command
to your powershell profile.
@ -51,5 +51,5 @@ kops completion powershell [flags]
### SEE ALSO
* [kops completion](kops_completion.md) - generate the autocompletion script for the specified shell
* [kops completion](kops_completion.md) - Generate the autocompletion script for the specified shell

View File

@ -3,23 +3,26 @@
## kops completion zsh
generate the autocompletion script for 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
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions for every new session, execute once:
# Linux:
$ kops completion zsh > "${fpath[1]}/_kops"
# macOS:
$ kops completion zsh > /usr/local/share/zsh/site-functions/_kops
#### Linux:
kops completion zsh > "${fpath[1]}/_kops"
#### macOS:
kops completion zsh > /usr/local/share/zsh/site-functions/_kops
You will need to start a new shell for this setup to take effect.
@ -58,5 +61,5 @@ kops completion zsh [flags]
### SEE ALSO
* [kops completion](kops_completion.md) - generate the autocompletion script for the specified shell
* [kops completion](kops_completion.md) - Generate the autocompletion script for the specified shell