Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.26.1.
Registry Casework project and local operator tooling.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.30.0 and catalog SHA-256 2221f17eae216048d4cfaf7f66e3dcd68a250f6f6de4e24b177441819192b475. Hidden implementation commands are omitted.
caseworkctl [OPTIONS] <COMMAND>Commands
Section titled “Commands”| Command | Description |
|---|---|
init | Create a complete Casework authoring project in a new directory |
source | Connect an authored source through its owning public tooling |
check | Validate authored inputs offline and print effective defaults |
explain | Explain the running policy from validated local inputs |
simulate | Evaluate a fixture using its controlled clock and source facts |
package | Package validated policy and exact imported descriptions for deployment |
test | Run the project’s bounded synthetic fixtures offline |
doctor | Check live database, issuer, source and directory readiness |
db | Manage Casework’s own database |
retention | Preview or erase retained local payload copies for one source request |
attempt | Preview or record an operator settlement of one uncertain source attempt |
dev | Start, stop and inspect this project’s retained local Casework runtime |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--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 |
-V, --version | No | n/a | n/a | n/a | Print version |
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.