From c49b27350b51d2099c8f2747158ccba890d0c917 Mon Sep 17 00:00:00 2001 From: Ole Markus With Date: Sun, 10 Apr 2022 10:28:37 +0200 Subject: [PATCH] Update CLI docs --- docs/cli/kops.md | 2 +- docs/cli/kops_completion.md | 11 +++++------ docs/cli/kops_completion_bash.md | 22 +++++++++++++--------- docs/cli/kops_completion_fish.md | 11 ++++++----- docs/cli/kops_completion_powershell.md | 8 ++++---- docs/cli/kops_completion_zsh.md | 19 +++++++++++-------- 6 files changed, 40 insertions(+), 33 deletions(-) diff --git a/docs/cli/kops.md b/docs/cli/kops.md index 9605984447..42f7e78bb1 100644 --- a/docs/cli/kops.md +++ b/docs/cli/kops.md @@ -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. diff --git a/docs/cli/kops_completion.md b/docs/cli/kops_completion.md index fbb148e9ee..3583d9e209 100644 --- a/docs/cli/kops_completion.md +++ b/docs/cli/kops_completion.md @@ -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 diff --git a/docs/cli/kops_completion_bash.md b/docs/cli/kops_completion_bash.md index 26c0670b39..fbeb420d41 100644 --- a/docs/cli/kops_completion_bash.md +++ b/docs/cli/kops_completion_bash.md @@ -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 diff --git a/docs/cli/kops_completion_fish.md b/docs/cli/kops_completion_fish.md index 1af11b402b..bf90f0aa00 100644 --- a/docs/cli/kops_completion_fish.md +++ b/docs/cli/kops_completion_fish.md @@ -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 diff --git a/docs/cli/kops_completion_powershell.md b/docs/cli/kops_completion_powershell.md index e8e1a989b0..ac89b4df7e 100644 --- a/docs/cli/kops_completion_powershell.md +++ b/docs/cli/kops_completion_powershell.md @@ -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 diff --git a/docs/cli/kops_completion_zsh.md b/docs/cli/kops_completion_zsh.md index 7e596e45df..960e7c4a5d 100644 --- a/docs/cli/kops_completion_zsh.md +++ b/docs/cli/kops_completion_zsh.md @@ -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