caseworkctl check command reference
Validate authored inputs offline and print effective defaults.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.38.0 and catalog SHA-256 cd13c658f65af295f9df3c6db86dc045ac06e9e040afc1f5f5b27c3184ab653d. Hidden implementation commands are omitted.
caseworkctl check [OPTIONS] <PROJECT>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--source-id <ID> is present | --against-breg-package <DIRECTORY> is required. |
Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<PROJECT> | Yes | n/a | n/a | n/a | Authored Casework project directory |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--production | No | n/a | n/a | n/a | Require every declared source import and all deployment policy inputs |
--deny-findings | No | n/a | n/a | n/a | Exit unsuccessfully when the authoring check reports any finding |
--against-breg-package <DIRECTORY> | No | n/a | n/a | n/a | Closed Base Registry Engine (BReg) package whose rederived registry revision must equal the pinned sourceRevision of a BReg source; verified by bregctl |
--source-id <ID> | No | n/a | n/a | n/a | BReg source to compare with the package; required when the project declares more than one |
--bregctl-bin <BREGCTL_BIN> | No | bregctl | n/a | BREGCTL_BIN | bregctl binary of the same release that verifies the package |
--format <FORMAT> | No | human | human, json | n/a | Emit the selected command’s report in this format |
-h, --help | No | n/a | n/a | n/a | Print help |
Generation contract
Section titled “Generation contract”Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.