Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.43.0.
caseworkctl provider add command reference
Create an approval project from a Base Registry Engine (BReg) Action and print missing configuration.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.44.0 and catalog SHA-256 1577fc2512d840ed27fdd70f4b3829f9f7796ab1a3a9a426c283904b3bf1a885. Hidden implementation commands are omitted.
caseworkctl provider add [OPTIONS] --breg-project <PROJECT> --action <ACTION> --pattern <PATTERN> <DIRECTORY>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--package-output <DIRECTORY> is present | --breg-package <DIRECTORY> is required. |
Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<DIRECTORY> | Yes | n/a | n/a | n/a | New Casework directory, or a previously generated project to check without rewriting |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--breg-project <PROJECT> | Yes | n/a | n/a | n/a | Authored BReg project inspected through its matching bregctl executable |
--action <ACTION> | Yes | n/a | n/a | n/a | Proposal-mode BReg Action to review |
--pattern <PATTERN> | Yes | n/a | single-reviewer-approval, two-peer-approval, technical-check-then-authorization | n/a | Approval stages and outcomes shared with caseworkctl init |
--breg-package <DIRECTORY> | No | n/a | n/a | n/a | Sealed BReg package to pair and compare before packaging Casework |
--package-output <DIRECTORY> | No | n/a | n/a | n/a | Package directory written with a new project; omit to inspect the package without writing it |
--bregctl-bin <BINARY> | No | bregctl | n/a | n/a | Matching bregctl executable used for public project and package inspection |
--format <FORMAT> | No | human | human, json | n/a | Write human diagnostics and reports, or one typed JSON report |
-h, --help | No | n/a | n/a | n/a | Print help |
Generation contract
Section titled “Generation contract”After changing a public command, argument, option, default, environment binding, or help description, run cargo run --locked -p registry-cli-docs -- --write, commit crates/registry-cli-docs/catalog.json, then run npm run generate from docs/site.