djpbessems/ContainerImage.Pinniped
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update CLI docs for v0.13.0 release

Browse Source
This commit is contained in:
Pinny 2022-01-21 23:12:12 +00:00
parent dea9bf9b90
commit 4f06cd3c2e
1 changed files with 35 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
site/content/docs/reference/cli.md
View File

@ -12,24 +12,28 @@ menu:
## pinniped completion bash ## pinniped completion bash
generate the autocompletion script for bash Generate the autocompletion script for bash
### Synopsis ### Synopsis
Generate the autocompletion script for the bash shell. Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package. This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager. If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session: To load completions in your current shell session:
$ source <(pinniped completion bash)
source <(pinniped completion bash)
To load completions for every new session, execute once: To load completions for every new session, execute once:
Linux:
$ pinniped completion bash > /etc/bash_completion.d/pinniped #### Linux:
MacOS:
$ pinniped completion bash > /usr/local/etc/bash_completion.d/pinniped 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. You will need to start a new shell for this setup to take effect.
@ -47,22 +51,23 @@ pinniped completion bash
### SEE ALSO ### SEE ALSO
* [pinniped completion]() - generate the autocompletion script for the specified shell * [pinniped completion]() - Generate the autocompletion script for the specified shell
## pinniped completion fish ## pinniped completion fish
generate the autocompletion script for fish Generate the autocompletion script for fish
### Synopsis ### Synopsis
Generate the autocompletion script for the fish shell. Generate the autocompletion script for the fish shell.
To load completions in your current shell session: To load completions in your current shell session:
$ pinniped completion fish | source
pinniped completion fish | source
To load completions for every new session, execute once: To load completions for every new session, execute once:
$ pinniped completion fish > ~/.config/fish/completions/pinniped.fish
pinniped completion fish > ~/.config/fish/completions/pinniped.fish
You will need to start a new shell for this setup to take effect. You will need to start a new shell for this setup to take effect.
@ -80,19 +85,19 @@ pinniped completion fish [flags]
### SEE ALSO ### SEE ALSO
* [pinniped completion]() - generate the autocompletion script for the specified shell * [pinniped completion]() - Generate the autocompletion script for the specified shell
## pinniped completion powershell ## pinniped completion powershell
generate the autocompletion script for powershell Generate the autocompletion script for powershell
### Synopsis ### Synopsis
Generate the autocompletion script for powershell. Generate the autocompletion script for powershell.
To load completions in your current shell session: To load completions in your current shell session:
PS C:\> pinniped completion powershell | Out-String | Invoke-Expression
pinniped completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command To load completions for every new session, add the output of the above command
to your powershell profile. to your powershell profile.
@ -111,27 +116,30 @@ pinniped completion powershell [flags]
### SEE ALSO ### SEE ALSO
* [pinniped completion]() - generate the autocompletion script for the specified shell * [pinniped completion]() - Generate the autocompletion script for the specified shell
## pinniped completion zsh ## pinniped completion zsh
generate the autocompletion script for zsh Generate the autocompletion script for zsh
### Synopsis ### Synopsis
Generate the autocompletion script for the zsh shell. Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once: 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: To load completions for every new session, execute once:
# Linux:
$ pinniped completion zsh > "${fpath[1]}/_pinniped" #### Linux:
# macOS:
$ pinniped completion zsh > /usr/local/share/zsh/site-functions/_pinniped 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. You will need to start a new shell for this setup to take effect.
@ -149,7 +157,7 @@ pinniped completion zsh [flags]
### SEE ALSO ### SEE ALSO
* [pinniped completion]() - generate the autocompletion script for the specified shell * [pinniped completion]() - Generate the autocompletion script for the specified shell
## pinniped get kubeconfig ## pinniped get kubeconfig
@ -173,6 +181,7 @@ pinniped get kubeconfig [flags]
--credential-cache string Path to cluster-specific credentials cache --credential-cache string Path to cluster-specific credentials cache
--generated-name-suffix string Suffix to append to generated cluster, context, user kubeconfig entries (default "-pinniped") --generated-name-suffix string Suffix to append to generated cluster, context, user kubeconfig entries (default "-pinniped")
-h, --help help for kubeconfig -h, --help help for kubeconfig
--install-hint string This text is shown to the user when the pinniped CLI is not installed. (default "The pinniped CLI does not appear to be installed. See https://get.pinniped.dev/cli for more details")
--kubeconfig string Path to kubeconfig file --kubeconfig string Path to kubeconfig file
--kubeconfig-context string Kubeconfig context name (default: current active context) --kubeconfig-context string Kubeconfig context name (default: current active context)
--no-concierge Generate a configuration which does not use the Concierge, but sends the credential to the cluster directly --no-concierge Generate a configuration which does not use the Concierge, but sends the credential to the cluster directly