Skip to content

Update CLI documentation #500

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EthanHeilman merged 1 commit into from
Mar 27, 2026
+18 −16
Merged

Update CLI documentation #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cli/opkssh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ opkssh [flags]
* [opkssh readhome](opkssh_readhome.md) - Read the principal's home policy file
* [opkssh verify](opkssh_verify.md) - Verify an SSH key (used by sshd AuthorizedKeysCommand)

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ opkssh add <principal> <email|sub|group> <issuer> [flags]

* [opkssh](opkssh.md) - SSH with OpenPubkey

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_audit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ opkssh audit [flags]

* [opkssh](opkssh.md) - SSH with OpenPubkey

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Interact with client configuration
* [opkssh](opkssh.md) - SSH with OpenPubkey
* [opkssh client provider](opkssh_client_provider.md) - Interact with provider configuration

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_client_provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Interact with provider configuration
* [opkssh client](opkssh_client.md) - Interact with client configuration
* [opkssh client provider list](opkssh_client_provider_list.md) - List configured providers

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_client_provider_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ opkssh client provider list [flags]

* [opkssh client provider](opkssh_client_provider.md) - Interact with provider configuration

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_inspect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ opkssh inspect <path> [flags]

* [opkssh](opkssh.md) - SSH with OpenPubkey

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
6 changes: 4 additions & 2 deletions docs/cli/opkssh_login.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,20 @@ opkssh login [alias] [flags]
--create-config Creates a client config file if it does not exist
--disable-browser-open Set this flag to disable opening the browser. Useful for choosing the browser you want to use
-h, --help help for login
--inspect-cert Print a human-readable inspection of the generated SSH certificate (public information only)
-t, --key-type Key Type Type of key to generate (default ecdsa)
--log-dir string Directory to write output logs
--print-id-token Set this flag to print out the contents of the id_token. Useful for inspecting claims
-p, --print-key Print private key and SSH cert instead of writing them to the filesystem
-p, --print-key Print the raw private key and SSH cert to stdout instead of writing them to the filesystem
-i, --private-key-file string Path where private keys is written
--provider string OpenID Provider specification in the format: <issuer>,<client_id> or <issuer>,<client_id>,<client_secret> or <issuer>,<client_id>,<client_secret>,<scopes>
--remote-redirect-uri string Remote redirect URI used for non-localhost redirects. This is an advanced option for embedding opkssh in server-side logic.
--send-access-token Set this flag to send the Access Token as well as the PK Token in the SSH cert. The Access Token is used to call the userinfo endpoint to get claims not included in the ID Token
-v, --verbose Enable verbose output
```

### SEE ALSO

* [opkssh](opkssh.md) - SSH with OpenPubkey

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_logout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ opkssh logout [flags]

* [opkssh](opkssh.md) - SSH with OpenPubkey

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_permissions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Check and fix filesystem permissions required by opkssh
* [opkssh permissions fix](opkssh_permissions_fix.md) - Fix permissions and ownership for opkssh files (requires admin)
* [opkssh permissions install](opkssh_permissions_install.md) - Idempotent installer-friendly permissions fix (non-interactive)

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_permissions_check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ opkssh permissions check [flags]

* [opkssh permissions](opkssh_permissions.md) - Check and fix filesystem permissions required by opkssh

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_permissions_fix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ opkssh permissions fix [flags]

* [opkssh permissions](opkssh_permissions.md) - Check and fix filesystem permissions required by opkssh

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_permissions_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ opkssh permissions install [flags]

* [opkssh permissions](opkssh_permissions.md) - Check and fix filesystem permissions required by opkssh

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_readhome.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ opkssh readhome <principal> [flags]

* [opkssh](opkssh.md) - SSH with OpenPubkey

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_verify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ opkssh verify <principal> <cert> <key_type> [flags]

* [opkssh](opkssh.md) - SSH with OpenPubkey

###### Auto generated by spf13/cobra on 26-Mar-2026
###### Auto generated by spf13/cobra on 27-Mar-2026