ContainerImage.Pinniped/site/content/docs/reference/cli.md

273 lines
8.2 KiB
Markdown
Raw Normal View History

---
title: Command-Line Options Reference
description: Reference for the `pinniped` command-line tool
cascade:
layout: docs
menu:
docs:
name: Command-Line Options
weight: 30
parent: reference
---
2021-08-31 23:21:54 +00:00
## pinniped completion bash
2022-01-21 23:12:12 +00:00
Generate the autocompletion script for bash
2021-08-31 23:21:54 +00:00
### 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:
2022-01-21 23:12:12 +00:00
source <(pinniped completion bash)
2021-08-31 23:21:54 +00:00
To load completions for every new session, execute once:
2022-01-21 23:12:12 +00:00
#### Linux:
pinniped completion bash > /etc/bash_completion.d/pinniped
#### macOS:
pinniped completion bash > /usr/local/etc/bash_completion.d/pinniped
2021-08-31 23:21:54 +00:00
You will need to start a new shell for this setup to take effect.
2022-01-21 23:12:12 +00:00
2021-08-31 23:21:54 +00:00
```
pinniped completion bash
```
### Options
```
-h, --help help for bash
--no-descriptions disable completion descriptions
```
### SEE ALSO
2022-01-21 23:12:12 +00:00
* [pinniped completion]() - Generate the autocompletion script for the specified shell
2021-08-31 23:21:54 +00:00
## pinniped completion fish
2022-01-21 23:12:12 +00:00
Generate the autocompletion script for fish
2021-08-31 23:21:54 +00:00
### Synopsis
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
2022-01-21 23:12:12 +00:00
pinniped completion fish | source
2021-08-31 23:21:54 +00:00
To load completions for every new session, execute once:
2022-01-21 23:12:12 +00:00
pinniped completion fish > ~/.config/fish/completions/pinniped.fish
2021-08-31 23:21:54 +00:00
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
2022-01-21 23:12:12 +00:00
* [pinniped completion]() - Generate the autocompletion script for the specified shell
2021-08-31 23:21:54 +00:00
## pinniped completion powershell
2022-01-21 23:12:12 +00:00
Generate the autocompletion script for powershell
2021-08-31 23:21:54 +00:00
### Synopsis
Generate the autocompletion script for powershell.
To load completions in your current shell session:
2022-01-21 23:12:12 +00:00
pinniped completion powershell | Out-String | Invoke-Expression
2021-08-31 23:21:54 +00:00
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
2022-01-21 23:12:12 +00:00
* [pinniped completion]() - Generate the autocompletion script for the specified shell
2021-08-31 23:21:54 +00:00
## pinniped completion zsh
2022-01-21 23:12:12 +00:00
Generate the autocompletion script for zsh
2021-08-31 23:21:54 +00:00
### 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:
2022-01-21 23:12:12 +00:00
echo "autoload -U compinit; compinit" >> ~/.zshrc
2021-08-31 23:21:54 +00:00
To load completions for every new session, execute once:
2022-01-21 23:12:12 +00:00
#### Linux:
pinniped completion zsh > "${fpath[1]}/_pinniped"
#### macOS:
pinniped completion zsh > /usr/local/share/zsh/site-functions/_pinniped
2021-08-31 23:21:54 +00:00
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
2022-01-21 23:12:12 +00:00
* [pinniped completion]() - Generate the autocompletion script for the specified shell
2021-08-31 23:21:54 +00:00
2021-04-01 19:15:23 +00:00
## pinniped get kubeconfig
2021-04-01 19:15:23 +00:00
Generate a Pinniped-based kubeconfig for a cluster
2021-04-01 19:15:23 +00:00
```
pinniped get kubeconfig [flags]
```
2021-04-01 19:15:23 +00:00
### Options
2021-04-01 19:15:23 +00:00
```
2021-06-02 15:22:13 +00:00
--concierge-api-group-suffix string Concierge API group suffix (default "pinniped.dev")
--concierge-authenticator-name string Concierge authenticator name (default: autodiscover)
--concierge-authenticator-type string Concierge authenticator type (e.g., 'webhook', 'jwt') (default: autodiscover)
--concierge-ca-bundle path Path to TLS certificate authority bundle (PEM format, optional, can be repeated) to use when connecting to the Concierge
--concierge-credential-issuer string Concierge CredentialIssuer object to use for autodiscovery (default: autodiscover)
--concierge-endpoint string API base for the Concierge endpoint
--concierge-mode mode Concierge mode of operation (default TokenCredentialRequestAPI)
--concierge-skip-wait Skip waiting for any pending Concierge strategies to become ready (default: false)
--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")
-h, --help help for kubeconfig
2022-01-21 23:12:12 +00:00
--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")
2021-06-02 15:22:13 +00:00
--kubeconfig string Path to kubeconfig file
--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
--oidc-ca-bundle path Path to TLS certificate authority bundle (PEM format, optional, can be repeated)
--oidc-client-id string OpenID Connect client ID (default: autodiscover) (default "pinniped-cli")
--oidc-issuer string OpenID Connect issuer URL (default: autodiscover)
--oidc-listen-port uint16 TCP port for localhost listener (authorization code flow only)
--oidc-request-audience string Request a token with an alternate audience using RFC8693 token exchange
--oidc-scopes strings OpenID Connect scopes to request during login (default [offline_access,openid,pinniped:request-audience])
--oidc-session-cache string Path to OpenID Connect session cache file
--oidc-skip-browser During OpenID Connect login, skip opening the browser (just print the URL)
-o, --output string Output file path (default: stdout)
--skip-validation Skip final validation of the kubeconfig (default: false)
--static-token string Instead of doing an OIDC-based login, specify a static token
--static-token-env string Instead of doing an OIDC-based login, read a static token from the environment
--timeout duration Timeout for autodiscovery and validation (default 10m0s)
2021-08-31 23:40:00 +00:00
--upstream-identity-provider-flow string The type of client flow to use with the upstream identity provider during login with a Supervisor (e.g. 'cli_password', 'browser_authcode')
2021-06-02 15:22:13 +00:00
--upstream-identity-provider-name string The name of the upstream identity provider used during login with a Supervisor
2021-08-31 23:40:00 +00:00
--upstream-identity-provider-type string The type of the upstream identity provider used during login with a Supervisor (e.g. 'oidc', 'ldap', 'activedirectory')
```
2021-04-01 19:15:23 +00:00
### SEE ALSO
2021-04-01 19:15:23 +00:00
* [pinniped get]() - get
2021-04-01 19:15:23 +00:00
## pinniped help
2021-04-01 19:15:23 +00:00
Help about any command
2021-04-01 19:15:23 +00:00
### Synopsis
2021-04-01 19:15:23 +00:00
Help provides help for any command in the application.
Simply type pinniped help [path to command] for full details.
2021-04-01 19:15:23 +00:00
```
pinniped help [command] [flags]
```
2021-04-01 19:15:23 +00:00
### Options
2021-04-01 19:15:23 +00:00
```
-h, --help help for help
```
2021-04-01 19:15:23 +00:00
### SEE ALSO
2021-04-01 19:15:23 +00:00
* [pinniped]() - pinniped
2021-04-01 19:15:23 +00:00
## pinniped version
2021-04-01 19:15:23 +00:00
Print the version of this Pinniped CLI
2021-04-01 19:15:23 +00:00
```
pinniped version [flags]
```
2021-04-01 19:15:23 +00:00
### Options
2021-04-01 19:15:23 +00:00
```
-h, --help help for version
```
2021-04-01 19:15:23 +00:00
### SEE ALSO
2021-04-01 19:15:23 +00:00
* [pinniped]() - pinniped
2021-04-01 19:15:23 +00:00
## pinniped whoami
2021-04-01 19:15:23 +00:00
Print information about the current user
2021-04-01 19:15:23 +00:00
```
pinniped whoami [flags]
```
2021-04-01 19:15:23 +00:00
### Options
2021-04-01 19:15:23 +00:00
```
--api-group-suffix string Concierge API group suffix (default "pinniped.dev")
-h, --help help for whoami
--kubeconfig string Path to kubeconfig file
--kubeconfig-context string Kubeconfig context name (default: current active context)
-o, --output string Output format (e.g., 'yaml', 'json', 'text') (default "text")
```
2021-04-01 19:15:23 +00:00
### SEE ALSO
2021-04-01 19:15:23 +00:00
* [pinniped]() - pinniped