From 49b9ecc05dff2d4125c153fda046ed8e3761b6d3 Mon Sep 17 00:00:00 2001 From: EthanHeilman <274814+EthanHeilman@users.noreply.github.com> Date: Mon, 13 Oct 2025 15:55:24 +0000 Subject: [PATCH] Update CLI documentation --- docs/cli/opkssh.md | 2 +- docs/cli/opkssh_add.md | 10 +++++----- docs/cli/opkssh_client.md | 2 +- docs/cli/opkssh_client_provider.md | 2 +- docs/cli/opkssh_client_provider_list.md | 2 +- docs/cli/opkssh_inspect.md | 2 +- docs/cli/opkssh_login.md | 2 +- docs/cli/opkssh_readhome.md | 6 +++--- docs/cli/opkssh_verify.md | 10 +++++----- 9 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/cli/opkssh.md b/docs/cli/opkssh.md index 9e3e00f7..2208dddc 100644 --- a/docs/cli/opkssh.md +++ b/docs/cli/opkssh.md @@ -37,4 +37,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 9-Oct-2025 +###### Auto generated by spf13/cobra on 13-Oct-2025 diff --git a/docs/cli/opkssh_add.md b/docs/cli/opkssh_add.md index 64f7b40b..59f1f30c 100644 --- a/docs/cli/opkssh_add.md +++ b/docs/cli/opkssh_add.md @@ -9,13 +9,13 @@ Add appends a new policy entry in the auth_id policy file granting SSH access to It first attempts to write to the system-wide file (/etc/opk/auth_id). If it lacks permissions to update this file it falls back to writing to the user-specific file (~/.opk/auth_id). Arguments: - PRINCIPAL The target user account (requested principal). - EMAIL|SUB|GROUP Email address, subscriber ID or group authorized to assume this principal. If using an OIDC group, the argument needs to be in the format of oidc:groups:. - ISSUER OpenID Connect provider (issuer) URL associated with the email/sub/group. + principal The target user account (requested principal). + email|sub|group Email address, subscriber ID or group authorized to assume this principal. If using an OIDC group, the argument needs to be in the format of oidc:groups:. + issuer OpenID Connect provider (issuer) URL associated with the email/sub/group. ``` -opkssh add [flags] +opkssh add [flags] ``` ### Examples @@ -36,4 +36,4 @@ opkssh add [flags] * [opkssh](opkssh.md) - SSH with OpenPubkey -###### Auto generated by spf13/cobra on 9-Oct-2025 +###### Auto generated by spf13/cobra on 13-Oct-2025 diff --git a/docs/cli/opkssh_client.md b/docs/cli/opkssh_client.md index 8e4dc87e..7488779e 100644 --- a/docs/cli/opkssh_client.md +++ b/docs/cli/opkssh_client.md @@ -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 9-Oct-2025 +###### Auto generated by spf13/cobra on 13-Oct-2025 diff --git a/docs/cli/opkssh_client_provider.md b/docs/cli/opkssh_client_provider.md index 97b74798..5029a322 100644 --- a/docs/cli/opkssh_client_provider.md +++ b/docs/cli/opkssh_client_provider.md @@ -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 9-Oct-2025 +###### Auto generated by spf13/cobra on 13-Oct-2025 diff --git a/docs/cli/opkssh_client_provider_list.md b/docs/cli/opkssh_client_provider_list.md index 1323ff27..90a98ff9 100644 --- a/docs/cli/opkssh_client_provider_list.md +++ b/docs/cli/opkssh_client_provider_list.md @@ -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 9-Oct-2025 +###### Auto generated by spf13/cobra on 13-Oct-2025 diff --git a/docs/cli/opkssh_inspect.md b/docs/cli/opkssh_inspect.md index be9737f8..8f04d16a 100644 --- a/docs/cli/opkssh_inspect.md +++ b/docs/cli/opkssh_inspect.md @@ -22,4 +22,4 @@ opkssh inspect [flags] * [opkssh](opkssh.md) - SSH with OpenPubkey -###### Auto generated by spf13/cobra on 9-Oct-2025 +###### Auto generated by spf13/cobra on 13-Oct-2025 diff --git a/docs/cli/opkssh_login.md b/docs/cli/opkssh_login.md index 19e9ec65..a53db1fd 100644 --- a/docs/cli/opkssh_login.md +++ b/docs/cli/opkssh_login.md @@ -46,4 +46,4 @@ opkssh login [alias] [flags] * [opkssh](opkssh.md) - SSH with OpenPubkey -###### Auto generated by spf13/cobra on 9-Oct-2025 +###### Auto generated by spf13/cobra on 13-Oct-2025 diff --git a/docs/cli/opkssh_readhome.md b/docs/cli/opkssh_readhome.md index 355f89f2..8040ea78 100644 --- a/docs/cli/opkssh_readhome.md +++ b/docs/cli/opkssh_readhome.md @@ -4,13 +4,13 @@ Read the principal's home policy file ### Synopsis -Read the principal's policy file (/home//.opk/auth_id). +Read the principal's policy file (/home//.opk/auth_id). You should not call this command directly. It is called by the opkssh verify command as part of the AuthorizedKeysCommand process to read the user's policy (principals) home file (~/.opk/auth_id) with sudoer permissions. This allows us to use an unprivileged user as the AuthorizedKeysCommand user. ``` -opkssh readhome [flags] +opkssh readhome [flags] ``` ### Examples @@ -29,4 +29,4 @@ opkssh readhome [flags] * [opkssh](opkssh.md) - SSH with OpenPubkey -###### Auto generated by spf13/cobra on 9-Oct-2025 +###### Auto generated by spf13/cobra on 13-Oct-2025 diff --git a/docs/cli/opkssh_verify.md b/docs/cli/opkssh_verify.md index 6b46c74a..2b394869 100644 --- a/docs/cli/opkssh_verify.md +++ b/docs/cli/opkssh_verify.md @@ -26,12 +26,12 @@ Verification checks performed: If all checks pass, Verify authorizes the SSH connection. Arguments: - PRINCIPAL Target username. - CERT Base64-encoded SSH certificate. - KEY_TYPE SSH certificate key type (e.g., ecdsa-sha2-nistp256-cert-v01@openssh.com) + principal Target username. + cert Base64-encoded SSH certificate. + key_type SSH certificate key type (e.g., ecdsa-sha2-nistp256-cert-v01@openssh.com) ``` -opkssh verify [flags] +opkssh verify [flags] ``` ### Examples @@ -51,4 +51,4 @@ opkssh verify [flags] * [opkssh](opkssh.md) - SSH with OpenPubkey -###### Auto generated by spf13/cobra on 9-Oct-2025 +###### Auto generated by spf13/cobra on 13-Oct-2025