caseworkctl package command reference
Package validated policy and exact imported descriptions for deployment.
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.
Description
Section titled “Description”Package validated policy and exact imported descriptions for deployment. The package is the unit caseworkctl plan and apply activate: a new directory holding the checked policy and the source descriptions it pins, named by the runtime configuration. bregctl package is a different verb that builds a Base Registry Engine (BReg) registry package from a tested BReg project.
caseworkctl package [OPTIONS] <PROJECT>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
| Command invocation | --dry-run and --output <DIRECTORY> cannot be used together. |
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 |
|---|---|---|---|---|---|
--output <DIRECTORY> | No | n/a | n/a | n/a | New directory for the verified policy package. Required unless —dry-run |
--dry-run | No | n/a | n/a | n/a | Report the same packageDigest and files a package would produce, without writing one |
--revision <TEXT> | No | n/a | n/a | n/a | Free-text revision recorded in the package’s REVISION file and covered by its digest |
--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 (see a summary with ‘-h’) |
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.