gritpack workspace [OPTIONS] <COMMAND>
Commands
- init
- Find the packages under a directory and write gritpack-workspace.toml
- status
- Show the members and where each dependency resolves: a member or a hub
- graph
- Show the dependencies between members and where each one comes from
- affected
- List the members that depend on a changed member
- verify
- Check the workspace and its installed packages, or a release with --immutable
- release-plan
- Show which members must be released together with the selected ones
Options
gritpack workspace init
Find the packages under a directory and write gritpack-workspace.toml
gritpack workspace init [OPTIONS]
Options
--path <PATH> | Directory to search for package manifestsDefault: . |
--dry-run | Print the proposed workspace without writing gritpack-workspace.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, --help | Print help |
gritpack workspace status
Show the members and where each dependency resolves: a member or a hub
gritpack workspace status [OPTIONS]
Options
--path <PATH> | Workspace root or gritpack-workspace.toml pathDefault: . |
--member <MEMBERS> | Only these members and their dependencies, by package name or path; repeat as needed |
--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 workspace graph
Show the dependencies between members and where each one comes from
gritpack workspace graph [OPTIONS]
Options
--path <PATH> | Workspace root or gritpack-workspace.toml pathDefault: . |
--member <MEMBERS> | Only these members and their dependencies, by package name or path; repeat as needed |
--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 workspace affected
List the members that depend on a changed member
gritpack workspace affected [OPTIONS] <CHANGED>
Arguments
<CHANGED> | Path or package name of the member that changed |
Options
--path <PATH> | Workspace root or gritpack-workspace.toml pathDefault: . |
--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 workspace verify
Check the workspace and its installed packages, or a release with --immutable
gritpack workspace verify [OPTIONS]
Options
--path <PATH> | Workspace root or gritpack-workspace.toml pathDefault: . |
--member <MEMBERS> | Only these members and their dependencies, by package name or path; repeat as needed |
--immutable | Plan a release of the members and check it with the hub, without publishing |
--cargo-registry <CARGO_REGISTRY> | With --immutable: Cargo registry name used in Cargo package metadataDefault: gritpack |
--package <CARGO_PACKAGES> | With --immutable: only these Cargo packages, by name; repeat as needed |
--cargo <CARGO> | With --immutable: Cargo program used to package Cargo membersDefault: cargo |
--rustc <RUSTC> | With --immutable: Rust compiler whose version is recorded for Cargo membersDefault: rustc |
--npm <NPM> | With --immutable: npm program used to package npm membersDefault: npm |
--allow-dirty | With --immutable: let Cargo package uncommitted changes |
--artifacts-dir <ARTIFACTS_DIR> | With --immutable: where built package files go, relative to the workspaceDefault: .gritpack/publication/artifacts |
--plan <PLAN> | With --immutable: where to write the release plan, relative to the workspaceDefault: .gritpack/immutable-verification-plan.json |
--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 |
gritpack workspace release-plan
Show which members must be released together with the selected ones
gritpack workspace release-plan [OPTIONS]
Options
--path <PATH> | Workspace root or gritpack-workspace.toml pathDefault: . |
--member <MEMBERS> | Only these members and their dependencies, by package name or path; repeat as needed |
--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 |