gritpack admin

Manage the hub: users, scopes, license rules and the audit log

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

Commands

user
Add, invite, list, suspend and delete accounts
invitation
Revoke an enrollment invitation that has not been used
scope
Assign, list and inspect package scopes
license-rule
Set which licenses packages may be published under
package
Quarantine or restore a published package version
signing-key
Register, list and revoke package-signing keys
audit-log
Read the hub's audit log of administrative changes
profile
Save hub administrator connections, so commands take --profile

Options

-h, --helpPrint help

Examples

$ gritpack admin user invite you@example.com --hub <host:port> --cert admin.pem --key admin-key.pem --ca ca.pem
$ gritpack admin user list --format json
$ gritpack admin scope assign frogfish --owner <account>

gritpack admin user

Add, invite, list, suspend and delete accounts

gritpack admin user [OPTIONS] <COMMAND>

Commands

add
Add an account
invite
Invite someone to log in to the hub
list
List accounts
view
Show an account and its credentials
suspend
Suspend an account at once
reactivate
Reactivate a suspended account
delete
Delete an account for good

Options

-h, --helpPrint help

gritpack admin user add

Add an account

gritpack admin user add [OPTIONS] <EMAIL>

Arguments

<EMAIL>Email address for the account

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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin user invite

Invite someone to log in to the hub

gritpack admin user invite [OPTIONS] <EMAIL>

Arguments

<EMAIL>Email address of the account to invite

Options

--downloadMake the invitation a link to a download that joins with one click, instead of printing an enrollment code
--enrollment-hub <HUB>The hub's public enrollment address, as host:port
--package-hub <HUB>The hub's public package address, as host:port
--invitee-profile <INVITEE_PROFILE>Profile name the invited person's login is saved as; default the package host's second label (hub.example.com → example)
--title <TITLE>What the download is called; default "Join <Profile>"
--download-hub <DOWNLOAD_HUB>Hub whose pages serve the downloadDefault: get.gritpack.org
--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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin user list

List accounts

gritpack admin user list [OPTIONS]

Options

--limit <LIMIT>Maximum records for this pageDefault: 100
--cursor <CURSOR>Continuation cursor from the previous page
--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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin user view

Show an account and its credentials

gritpack admin user view [OPTIONS] <ACCOUNT>

Arguments

<ACCOUNT>The account's email or UUID

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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin user suspend

Suspend an account at once

gritpack admin user suspend [OPTIONS] <ACCOUNT>

Arguments

<ACCOUNT>The account's email or UUID

Options

--format <FORMAT>Output format: human or jsonDefault: human · Values: human, json
-y, --yesDo it without asking
--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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin user reactivate

Reactivate a suspended account

gritpack admin user reactivate [OPTIONS] <ACCOUNT>

Arguments

<ACCOUNT>The account's email or UUID

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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin user delete

Delete an account for good

gritpack admin user delete [OPTIONS] <ACCOUNT>

Arguments

<ACCOUNT>The account's email or UUID

Options

--format <FORMAT>Output format: human or jsonDefault: human · Values: human, json
-y, --yesDo it without asking
--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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin invitation

Revoke an enrollment invitation that has not been used

gritpack admin invitation [OPTIONS] <COMMAND>

Commands

revoke
Revoke an enrollment invitation that has not been used

Options

-h, --helpPrint help

gritpack admin invitation revoke

Revoke an enrollment invitation that has not been used

gritpack admin invitation revoke [OPTIONS] <INVITATION_ID>

Arguments

<INVITATION_ID>Enrollment invitation UUID

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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin scope

Assign, list and inspect package scopes

gritpack admin scope [OPTIONS] <COMMAND>

Commands

assign
Give a scope to an account
list
List assigned scopes
view
Show a scope and its owner
unassign
Take a scope away from its owner

Options

-h, --helpPrint help

gritpack admin scope assign

Give a scope to an account

gritpack admin scope assign [OPTIONS] --owner <ACCOUNT> <SCOPE>

Arguments

<SCOPE>The scope, such as @frogfish or frogfish

Options

--owner <ACCOUNT>The email or UUID of the account that will own the scope
--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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin scope list

List assigned scopes

gritpack admin scope list [OPTIONS]

Options

--limit <LIMIT>Maximum records for this pageDefault: 100
--cursor <CURSOR>Continuation cursor from the previous page
--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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin scope view

Show a scope and its owner

gritpack admin scope view [OPTIONS] <SCOPE>

Arguments

<SCOPE>The scope, such as @frogfish or frogfish

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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin scope unassign

Take a scope away from its owner

gritpack admin scope unassign [OPTIONS] <SCOPE>

Arguments

<SCOPE>The scope, such as @frogfish or frogfish

Options

--format <FORMAT>Output format: human or jsonDefault: human · Values: human, json
-y, --yesDo it without asking
--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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin license-rule

Set which licenses packages may be published under

gritpack admin license-rule [OPTIONS] <COMMAND>

Commands

list
List the license rules, or with --refused the versions they refuse
set
Set the licenses the hub, an account, a scope or a name may use
clear
Remove a license rule

Options

-h, --helpPrint help

gritpack admin license-rule list

List the license rules, or with --refused the versions they refuse

gritpack admin license-rule list [OPTIONS]

Options

--refusedList the published native and Cargo versions the rules would refuse now, instead of the rules
--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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin license-rule set

Set the licenses the hub, an account, a scope or a name may use

gritpack admin license-rule set [OPTIONS] <SUBJECT> <ALLOWED>...

Arguments

<SUBJECT>hub for every name no other rule covers, account:<email or id> for everything an account publishes, @<scope> for one scope, or name:<package name> for one name. The most specific rule decides
<ALLOWED>...SPDX licenses allowed, one each, such as MIT or LicenseRef-Frogfish-Binary-License-1.0

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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin license-rule clear

Remove a license rule

gritpack admin license-rule clear [OPTIONS] <SUBJECT>

Arguments

<SUBJECT>hub, account:<email or id>, @<scope> or name:<package name>

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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin package

Quarantine or restore a published package version

gritpack admin package [OPTIONS] <COMMAND>

Commands

quarantine
Hide a published version from everyone
unquarantine
Restore a quarantined version

Options

-h, --helpPrint help

gritpack admin package quarantine

Hide a published version from everyone

gritpack admin package quarantine [OPTIONS] <VERSION> <REASON>

Arguments

<VERSION>The published version, as name@version or its storage ID
<REASON>Reason recorded with the quarantine (1-512 bytes)

Options

-y, --yesDo it without asking
--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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin package unquarantine

Restore a quarantined version

gritpack admin package unquarantine [OPTIONS] <VERSION>

Arguments

<VERSION>The published version, as name@version or its storage ID

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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin signing-key

Register, list and revoke package-signing keys

gritpack admin signing-key [OPTIONS] <COMMAND>

Commands

add
Register an account's or scope's package-signing key
list
List the signing keys of an account or scope
revoke
Revoke a signing key

Options

-h, --helpPrint help

gritpack admin signing-key add

Register an account's or scope's package-signing key

gritpack admin signing-key add [OPTIONS] --account <ACCOUNT> --publisher <PUBLISHER> --public-key <PUBLIC_KEY>

Options

--account <ACCOUNT>Email or UUID of the account that owns the key
--publisher <PUBLISHER>Who the key signs for: the account (email or UUID) or a scope it owns, as @scope
--public-key <PUBLIC_KEY>File with the Ed25519 public key: 32 raw bytes or unpadded base64url
--valid-from <VALID_FROM>Unix time from which the key's signatures count; default now
--valid-until <VALID_UNTIL>Unix time at which the key's signatures stop counting; default never
-h, --helpPrint help

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin signing-key list

List the signing keys of an account or scope

gritpack admin signing-key list [OPTIONS] --publisher <PUBLISHER>

Options

--publisher <PUBLISHER>The publisher: an account's email or UUID, or a scope as @scope
--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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin signing-key revoke

Revoke a signing key

gritpack admin signing-key revoke [OPTIONS] --reason <REASON> <KEY_ID>

Arguments

<KEY_ID>ID of the key to revoke, as gritpack admin signing-key list prints it

Options

--reason <REASON>Why the key is revokedValues: superseded, compromised, retired, administrative
--effective-at <EFFECTIVE_AT>Unix time from which the key's signatures are refused; default now
--compromise-at <COMPROMISE_AT>Unix time the key was compromised; needs --invalidates-prior
--invalidates-priorAlso refuse older signatures: all of them, or those from --compromise-at
-h, --helpPrint help

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin audit-log

Read the hub's audit log of administrative changes

gritpack admin audit-log [OPTIONS]

Options

--limit <LIMIT>Maximum records for this pageDefault: 100
--cursor <CURSOR>Continuation cursor from the previous page
--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

Administrator connection

--profile <PROFILE>Administrator profile to use; default the one admin profile use choseEnvironment: GRITPACK_ADMIN_PROFILE
--hub <HUB>The hub's management address, as host[:port]Environment: GRITPACK_MANAGEMENT_SERVER
--cert <CERT>Administrator client certificateEnvironment: GRITPACK_ADMIN_CERT
--key <KEY>Private key for the administrator certificateEnvironment: GRITPACK_ADMIN_KEY
--ca <CA>Certificate authority used to authenticate the hubEnvironment: GRITPACK_CA

gritpack admin profile

Save hub administrator connections, so commands take --profile

gritpack admin profile [OPTIONS] <COMMAND>

Commands

add
Save a hub's administrator connection under a name
list
List the saved administrator connections
use
Choose the administrator connection used when none is named
remove
Forget a saved administrator connection; its files are left alone

Options

-h, --helpPrint help

gritpack admin profile add

Save a hub's administrator connection under a name

gritpack admin profile add [OPTIONS] --hub <HUB> --cert <CERT> --key <KEY> --ca <CA> <NAME>

Arguments

<NAME>Name to save it as

Options

--hub <HUB>The hub's management address, as host[:port]
--cert <CERT>Administrator client certificate file
--key <KEY>Private key file for the administrator certificate
--ca <CA>Certificate authority file used to authenticate the hub
--defaultMake it the one used when no --profile is given
-h, --helpPrint help

Examples

$ gritpack admin profile add public --hub get.gritpack.org:7444 \
    --cert admin.pem --key admin-key.pem --ca /etc/ssl/cert.pem
$ gritpack admin user list --profile public

gritpack admin profile list

List the saved administrator connections

gritpack admin profile list [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

gritpack admin profile use

Choose the administrator connection used when none is named

gritpack admin profile use [OPTIONS] <NAME>

Arguments

<NAME>The administrator profile's name

Options

-h, --helpPrint help

gritpack admin profile remove

Forget a saved administrator connection; its files are left alone

gritpack admin profile remove [OPTIONS] <NAME>

Arguments

<NAME>The administrator profile's name

Options

-h, --helpPrint help