Registry stack documentation: machine-readable Markdown.
Index of all pages: https://docs.registrystack.org/v/0.38.0/llms.txt
Full corpus: https://docs.registrystack.org/v/0.38.0/llms-full.txt

# caseworkctl command reference

> Generated syntax and options for caseworkctl.

{/* Generated from Clap command definitions by scripts/generate-cli-reference.mjs. Run npm run generate. */}

Registry Casework project and local operator tooling.

## 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.

## Usage

```text
caseworkctl [OPTIONS] <COMMAND>
```

## Commands

| Command | Description |
| --- | --- |
| [`init`](./init/) | Create a complete Casework authoring project in a new directory |
| [`source`](./source/) | Connect an authored source through its owning public tooling |
| [`check`](./check/) | Validate authored inputs offline and print effective defaults |
| [`explain`](./explain/) | Explain the running policy from validated local inputs |
| [`lifecycle`](./lifecycle/) | Report the occurrence and review state machines the runtime enforces |
| [`simulate`](./simulate/) | Evaluate a fixture using its controlled clock and source facts |
| [`package`](./package/) | Package validated policy and exact imported descriptions for deployment |
| [`test`](./test/) | Run the project's bounded synthetic fixtures offline |
| [`doctor`](./doctor/) | Check live database, issuer, source and directory readiness |
| [`plan`](./plan/) | Report what applying the configured package would change, without writing |
| [`apply`](./apply/) | Apply the configured package with migration authority and record it as active |
| [`status`](./status/) | Report the active package, every activation, and the runtime role mode |
| [`retention`](./retention/) | Preview or erase retained local payload copies for one source request |
| [`attempt`](./attempt/) | Preview or record an operator decision about one source attempt whose lease has expired |
| [`dev`](./dev/) | Start, stop and inspect this project's retained local Casework runtime |

## 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

Run `npm run generate` from `docs/site` after changing a public command, argument, option, default, environment binding, or help description.