gritpack package

Yank or deprecate a published version

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

Commands

yank
Stop new projects from choosing a published version
unyank
Let new projects choose a yanked version again
deprecate
Warn everyone who uses a version, with a message
undeprecate
Remove a version's deprecation warning
sign
Sign a package file as its publisher, for evidence attach

Options

-h, --helpPrint help

Examples

$ gritpack package yank @frogfish/parser@1.2.0
$ gritpack package deprecate @frogfish/parser@1.2.0 "Use @frogfish/parser2"

gritpack package yank

Stop new projects from choosing a published version

gritpack package yank [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 (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 package unyank

Let new projects choose a yanked version again

gritpack package unyank [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 (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 package deprecate

Warn everyone who uses a version, with a message

gritpack package deprecate [OPTIONS] <VERSION> <MESSAGE>

Arguments

<VERSION>The published version, as name@version or its storage ID
<MESSAGE>Message for its users, such as what to use instead (1-512 bytes)

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 package undeprecate

Remove a version's deprecation warning

gritpack package undeprecate [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 (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 package sign

Sign a package file as its publisher, for evidence attach

gritpack package sign [OPTIONS] --publisher <PUBLISHER> --signing-seed <SIGNING_SEED> <PACKAGE_FILE>

Arguments

<PACKAGE_FILE>The package file to sign, as pack or publication plan wrote it

Options

--publisher <PUBLISHER>Who signs: your account's ID or a scope you own, as @scope. It must match the key's registration
--signing-seed <SIGNING_SEED>File holding the private signing seed (32 bytes, raw or base64url)
--output <OUTPUT>Where to write the signature; default the package file's name plus .sig
--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

Examples

$ gritpack package sign parser-1.2.0.capsule --publisher @frogfish --signing-seed publisher.seed
$ gritpack evidence attach <transaction> <node> parser-1.2.0.capsule.sig
The seed is the private half of a key an administrator registered with
`gritpack admin signing-key add`; `gritpack evidence public-key` prints the
public half to register.