gritpack slice [OPTIONS] <COMMAND>
Commands
- plan
- Plan putting a bundle's packages in a static repository, changing nothing
- verify
- Check a saved plan, its bundle, and that the repository has not changed
- promote
- Write a planned bundle into the static repository as a new generation
- reconcile
- Plan again from a newer bundle and the repository as it is now
- status
- Check and show the static repository's current generation
- acquire
- Check a static repository and copy its packages into the local cache
- promote-live
- Publish a signed bundle's packages to a hub, all or none
Options
gritpack slice plan
Plan putting a bundle's packages in a static repository, changing nothing
gritpack slice plan [OPTIONS] --bundle <BUNDLE> --bundle-key <BUNDLE_KEYS> --destination <DESTINATION> --repository <REPOSITORY> --destination-key <DESTINATION_KEYS> --actor <ACTOR> --output <OUTPUT>
Options
--bundle <BUNDLE> | Signed bundle made by gritpack bundle export |
--bundle-key <BUNDLE_KEYS> | File with an Ed25519 public key trusted to sign the bundle; repeatable |
--bundle-threshold <BUNDLE_THRESHOLD> | How many of the bundle keys must have signed the bundleDefault: 1 |
--destination <DESTINATION> | Directory of the static repository, ready to serve as plain files |
--repository <REPOSITORY> | UUID of the static repository |
--destination-key <DESTINATION_KEYS> | File with an Ed25519 public key trusted to sign the repository; repeatable |
--destination-threshold <DESTINATION_THRESHOLD> | How many of the repository keys must have signed each generationDefault: 1 |
--actor <ACTOR> | Person or service making the plan, recorded in it |
--output <OUTPUT> | Where to write the plan file |
--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, --help | Print help |
gritpack slice verify
Check a saved plan, its bundle, and that the repository has not changed
gritpack slice verify [OPTIONS] --plan <PLAN> --bundle <BUNDLE> --bundle-key <BUNDLE_KEYS> --destination <DESTINATION> --repository <REPOSITORY> --destination-key <DESTINATION_KEYS>
Options
--plan <PLAN> | Plan file written by gritpack slice plan |
--bundle <BUNDLE> | Signed bundle made by gritpack bundle export |
--bundle-key <BUNDLE_KEYS> | File with an Ed25519 public key trusted to sign the bundle; repeatable |
--bundle-threshold <BUNDLE_THRESHOLD> | How many of the bundle keys must have signed the bundleDefault: 1 |
--destination <DESTINATION> | Directory of the static repository, ready to serve as plain files |
--repository <REPOSITORY> | UUID of the static repository |
--destination-key <DESTINATION_KEYS> | File with an Ed25519 public key trusted to sign the repository; repeatable |
--destination-threshold <DESTINATION_THRESHOLD> | How many of the repository keys must have signed each generationDefault: 1 |
--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, --help | Print help |
Write a planned bundle into the static repository as a new generation
gritpack slice promote [OPTIONS] --plan <PLAN> --bundle <BUNDLE> --bundle-key <BUNDLE_KEYS> --destination <DESTINATION> --repository <REPOSITORY> --destination-key <DESTINATION_KEYS> --signing-seed <SIGNING_SEED>
Options
--plan <PLAN> | Plan file written by gritpack slice plan |
--bundle <BUNDLE> | Signed bundle made by gritpack bundle export |
--bundle-key <BUNDLE_KEYS> | File with an Ed25519 public key trusted to sign the bundle; repeatable |
--bundle-threshold <BUNDLE_THRESHOLD> | How many of the bundle keys must have signed the bundleDefault: 1 |
--destination <DESTINATION> | Directory of the static repository, ready to serve as plain files |
--repository <REPOSITORY> | UUID of the static repository |
--destination-key <DESTINATION_KEYS> | File with an Ed25519 public key trusted to sign the repository; repeatable |
--destination-threshold <DESTINATION_THRESHOLD> | How many of the repository keys must have signed each generationDefault: 1 |
--signing-seed <SIGNING_SEED> | File with the repository's Ed25519 signing seed: 32 raw bytes or 64 hex digits |
--lifetime-seconds <LIFETIME_SECONDS> | How long the new generation stays valid, in secondsDefault: 86400 |
--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, --help | Print help |
gritpack slice reconcile
Plan again from a newer bundle and the repository as it is now
gritpack slice reconcile [OPTIONS] --bundle <BUNDLE> --bundle-key <BUNDLE_KEYS> --destination <DESTINATION> --repository <REPOSITORY> --destination-key <DESTINATION_KEYS> --actor <ACTOR> --output <OUTPUT>
Options
--bundle <BUNDLE> | Signed bundle made by gritpack bundle export |
--bundle-key <BUNDLE_KEYS> | File with an Ed25519 public key trusted to sign the bundle; repeatable |
--bundle-threshold <BUNDLE_THRESHOLD> | How many of the bundle keys must have signed the bundleDefault: 1 |
--destination <DESTINATION> | Directory of the static repository, ready to serve as plain files |
--repository <REPOSITORY> | UUID of the static repository |
--destination-key <DESTINATION_KEYS> | File with an Ed25519 public key trusted to sign the repository; repeatable |
--destination-threshold <DESTINATION_THRESHOLD> | How many of the repository keys must have signed each generationDefault: 1 |
--actor <ACTOR> | Person or service making the plan, recorded in it |
--output <OUTPUT> | Where to write the plan file |
--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, --help | Print help |
gritpack slice status
Check and show the static repository's current generation
gritpack slice status [OPTIONS] --destination <DESTINATION> --repository <REPOSITORY> --destination-key <DESTINATION_KEYS>
Options
--destination <DESTINATION> | Directory of the static repository, ready to serve as plain files |
--repository <REPOSITORY> | UUID of the static repository |
--destination-key <DESTINATION_KEYS> | File with an Ed25519 public key trusted to sign the repository; repeatable |
--destination-threshold <DESTINATION_THRESHOLD> | How many of the repository keys must have signed each generationDefault: 1 |
--offline | Accept an expired generation, reporting it as out of date |
--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, --help | Print help |
gritpack slice acquire
Check a static repository and copy its packages into the local cache
gritpack slice acquire [OPTIONS] --from <SOURCE> --repository <REPOSITORY> --trusted-key <TRUSTED_KEYS>
Options
--from <SOURCE> | The static repository: an absolute directory, or an https:// URL without credentials |
--repository <REPOSITORY> | UUID the repository must have |
--trusted-key <TRUSTED_KEYS> | File with an Ed25519 public key trusted to sign the repository; repeatable |
--ca <CA> | Extra PEM certificate authorities for a private HTTPS repository |
--threshold <THRESHOLD> | How many of the trusted keys must have signed the generationDefault: 1 |
--cache-dir <CACHE_DIR> | Directory of the shared cache of downloaded package filesEnvironment: GRITPACK_CACHE_DIR · Default: ~/.frogfish/gritpack/cache |
--state <STATE> | State saved by an earlier --save-state; older generations are refused |
--save-state <SAVE_STATE> | Where to save the accepted generation, for a later --state |
--offline | Accept an expired generation, reporting it as out of date |
--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, --help | Print help |
Publish a signed bundle's packages to a hub, all or none
gritpack slice promote-live [OPTIONS] --bundle <BUNDLE> --bundle-key <BUNDLE_KEYS> --repository <REPOSITORY>
Options
--bundle <BUNDLE> | Signed bundle made by gritpack bundle export |
--bundle-key <BUNDLE_KEYS> | File with an Ed25519 public key trusted to sign the bundle; repeatable |
--bundle-threshold <BUNDLE_THRESHOLD> | How many of the bundle keys must have signed the bundleDefault: 1 |
--repository <REPOSITORY> | UUID of the hub's repository; it must match the hub |
--dry-run | Print the publication plan without publishing |
--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, --help | Print 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 |