From 0a2a716796a5ed7e1c21af312cc19c25c41e2710 Mon Sep 17 00:00:00 2001 From: Pinny Date: Tue, 31 Aug 2021 23:21:54 +0000 Subject: [PATCH] Update CLI docs for v0.10.0 release --- site/content/docs/reference/cli.md | 141 +++++++++++++++++++++++++++++ 1 file changed, 141 insertions(+) diff --git a/site/content/docs/reference/cli.md b/site/content/docs/reference/cli.md index c6beb357e..cd155c1ab 100644 --- a/site/content/docs/reference/cli.md +++ b/site/content/docs/reference/cli.md @@ -10,6 +10,147 @@ menu: parent: reference --- +## pinniped completion 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 <(pinniped completion bash) + +To load completions for every new session, execute once: +Linux: + $ pinniped completion bash > /etc/bash_completion.d/pinniped +MacOS: + $ pinniped completion bash > /usr/local/etc/bash_completion.d/pinniped + +You will need to start a new shell for this setup to take effect. + + +``` +pinniped completion bash +``` + +### Options + +``` + -h, --help help for bash + --no-descriptions disable completion descriptions +``` + +### SEE ALSO + +* [pinniped completion]() - generate the autocompletion script for the specified shell + +## pinniped completion fish + +generate the autocompletion script for fish + +### Synopsis + + +Generate the autocompletion script for the fish shell. + +To load completions in your current shell session: +$ pinniped completion fish | source + +To load completions for every new session, execute once: +$ pinniped completion fish > ~/.config/fish/completions/pinniped.fish + +You will need to start a new shell for this setup to take effect. + + +``` +pinniped completion fish [flags] +``` + +### Options + +``` + -h, --help help for fish + --no-descriptions disable completion descriptions +``` + +### SEE ALSO + +* [pinniped completion]() - generate the autocompletion script for the specified shell + +## pinniped completion powershell + +generate the autocompletion script for powershell + +### Synopsis + + +Generate the autocompletion script for powershell. + +To load completions in your current shell session: +PS C:\> pinniped completion powershell | Out-String | Invoke-Expression + +To load completions for every new session, add the output of the above command +to your powershell profile. + + +``` +pinniped completion powershell [flags] +``` + +### Options + +``` + -h, --help help for powershell + --no-descriptions disable completion descriptions +``` + +### SEE ALSO + +* [pinniped completion]() - generate the autocompletion script for the specified shell + +## pinniped 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 for every new session, execute once: +# Linux: +$ pinniped completion zsh > "${fpath[1]}/_pinniped" +# macOS: +$ pinniped completion zsh > /usr/local/share/zsh/site-functions/_pinniped + +You will need to start a new shell for this setup to take effect. + + +``` +pinniped completion zsh [flags] +``` + +### Options + +``` + -h, --help help for zsh + --no-descriptions disable completion descriptions +``` + +### SEE ALSO + +* [pinniped completion]() - generate the autocompletion script for the specified shell + ## pinniped get kubeconfig Generate a Pinniped-based kubeconfig for a cluster