gritpack auth

List, switch, renew and remove your hub logins

Generated from gritpack auth --helpGritpack 1.2.63
gritpack auth [OPTIONS] <COMMAND>

Commands

list
List configured logins without displaying credential paths or secrets
use
Select the default login
status
Verify the selected login and show its account and writable scopes
renew
Enroll and activate a replacement credential before retiring the old one
migrate
Move a login credential to another supported credential store
logout
Revoke and remove a login profile without exposing its credential
import
Save a login from a certificate and key you already have
revoke
Revoke one of your account's credentials

Options

-h, --helpPrint help

Examples

$ gritpack auth status
$ gritpack auth list
$ gritpack auth use work
$ gritpack auth renew

gritpack auth list

List configured logins without displaying credential paths or secrets

gritpack auth list [OPTIONS]

Options

--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--format <FORMAT>Output format: human or jsonDefault: human · Values: human, json
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help

gritpack auth use

Select the default login

gritpack auth use [OPTIONS] <NAME>

Arguments

<NAME>Login profile to make the default

Options

--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
-h, --helpPrint help

gritpack auth status

Verify the selected login and show its account and writable scopes

gritpack auth status [OPTIONS]

Options

--format <FORMAT>Output format: human or jsonDefault: human · Values: human, json
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4

gritpack auth renew

Enroll and activate a replacement credential before retiring the old one

gritpack auth renew [OPTIONS]

Options

--profile <PROFILE>Login profile; the selected default is used when omitted
--email <EMAIL>Account email address; prompted on an interactive terminal when omitted
--hub <HUB>The hub's enrollment address; needed for hubs other than the public one
--ca <CA>Certificate authority used to authenticate the hub; defaults to the profile's
--code <ENROLLMENT_CODE>Short-lived enrollment code; prompted on an interactive terminal when omittedEnvironment: GRITPACK_ENROLLMENT_CODE · Also: --enrollment-code
--store <STORE>Where to keep the new credential; the current store when omittedValues: file, keychain, run
--credentials-dir <CREDENTIALS_DIR>Parent directory for issued credential directoriesEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--run-project <RUN_PROJECT>Project in the run secret store for the replacement credential
--run-environment <RUN_ENVIRONMENT>Environment in the run secret store for the replacement credential
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
-h, --helpPrint help

gritpack auth migrate

Move a login credential to another supported credential store

gritpack auth migrate [OPTIONS] --store <STORE>

Options

--profile <PROFILE>Login profile; the selected default is used when omitted
--store <STORE>Where to keep the credential from now onValues: file, keychain, run
--credentials-dir <CREDENTIALS_DIR>Parent directory used when migrating to file storageEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--run-project <RUN_PROJECT>Project in the run secret store, when migrating thereDefault: gritpack
--run-environment <RUN_ENVIRONMENT>Environment in the run secret store, when migrating thereDefault: default
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
-h, --helpPrint help

gritpack auth logout

Revoke and remove a login profile without exposing its credential

gritpack auth logout [OPTIONS]

Options

--profile <PROFILE>Login profile; the selected default is used when omitted
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--local-onlyRemove local configuration without contacting the hub
-y, --yesDo it without asking
-h, --helpPrint help

gritpack auth import

Save a login from a certificate and key you already have

gritpack auth import [OPTIONS] --hub <HUB> --cert <CERT> --key <KEY> <NAME>

Arguments

<NAME>Name for the login profile, in lowercase

Options

--hub <HUB>The hub, as host[:port]
--cert <CERT>Client certificate for the hub
--key <KEY>Private key for the client certificate
--ca <CA>Certificate authority used to authenticate the hub
--defaultMake this profile the default
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
-h, --helpPrint help

gritpack auth revoke

Revoke one of your account's credentials

gritpack auth revoke [OPTIONS] <CREDENTIAL_ID>

Arguments

<CREDENTIAL_ID>ID of one of your credentials, as gritpack auth status shows it

Options

--format <FORMAT>Output format: human or jsonDefault: human · Values: human, json
--json[=<FIELDS>]Same as --format json; --json=name,version keeps only those fields
--jq <EXPRESSION>Print the JSON output through a jq expression, strings unquoted
-h, --helpPrint help (see a summary with '-h')

Hub connection

--hub <HUB>The hub, as host[:port] or https://host[:port]Environment: GRITPACK_SERVER
--cert <CERT>Client certificate for the hubEnvironment: GRITPACK_CERT
--key <KEY>Private key for the client certificateEnvironment: GRITPACK_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA
--profile <PROFILE>Login profile to use; cannot be combined with --hub, --cert, --key or --caEnvironment: GRITPACK_PROFILE
--config <CONFIG>Profile configuration fileEnvironment: GRITPACK_CONFIG · Default: ~/.frogfish/gritpack/config.toml
--credentials-dir <CREDENTIALS_DIR>With --hub alone: directory searched for your login; exactly one may be unexpiredEnvironment: GRITPACK_CREDENTIALS_DIR · Default: ~/.frogfish/gritpack/credentials
--cache-dir <CACHE_DIR>Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache
--jobs <JOBS>How many package downloads to run at once (1-64)Environment: GRITPACK_JOBS · Default: 4