Skip to content

Update CLI documentation #498

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
Merged

Update CLI documentation #498

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
3 changes: 2 additions & 1 deletion docs/cli/opkssh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ opkssh [flags]
* [opkssh client](opkssh_client.md) - Interact with client configuration
* [opkssh inspect](opkssh_inspect.md) - Inspect and view details of an opkssh generated SSH key
* [opkssh login](opkssh_login.md) - Authenticate with an OpenID Provider to generate an SSH key for opkssh
* [opkssh logout](opkssh_logout.md) - Remove opkssh-generated SSH keys and certificates
* [opkssh permissions](opkssh_permissions.md) - Check and fix filesystem permissions required by opkssh
* [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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-Mar-2026
2 changes: 1 addition & 1 deletion docs/cli/opkssh_login.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ opkssh login [alias] [flags]

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

###### Auto generated by spf13/cobra on 23-Mar-2026
###### Auto generated by spf13/cobra on 26-Mar-2026
36 changes: 36 additions & 0 deletions docs/cli/opkssh_logout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## opkssh logout

Remove opkssh-generated SSH keys and certificates

### Synopsis

Logout removes SSH keys and certificates that were generated by opkssh.

By default it searches the standard SSH key locations (~/.ssh/) and the opkssh identity directory (~/.ssh/opkssh/) for keys generated by opkssh and removes them.

Use the -i flag to remove a specific key pair.

```
opkssh logout [flags]
```

### Examples

```
opkssh logout
opkssh logout -i ~/.ssh/id_ecdsa
```

### Options

```
-h, --help help for logout
-i, --private-key-file string Path to the specific private key to remove
-v, --verbose Print verbose output to stderr
```

### SEE ALSO

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

###### Auto generated by spf13/cobra on 26-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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-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 23-Mar-2026
###### Auto generated by spf13/cobra on 26-Mar-2026