caseworkctl dev command reference
Start, stop and inspect this project’s retained local Casework runtime.
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 dev [OPTIONS] [PROJECT] caseworkctl dev <COMMAND>Commands
Section titled “Commands”| Command | Description |
|---|---|
start | Start or reuse the project’s retained local database and services |
stop | Stop only this project’s supervised services, preserving its database |
events | Print the bounded retained runtime journal |
token | Write a fresh bearer header for a registered local teaching or service client |
grant | Exchange an existing Casework approval using an explicit configured issuer connection |
identity | Show a stable native subject before authoring local directory or task templates |
Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
[PROJECT] | No | . | n/a | n/a | Existing authored Casework project directory |
Options
Section titled “Options”| Option | Always required | Repeatable | Default | Values | Environment | Description |
|---|---|---|---|---|---|---|
--clients-file <FILE> | No | No | n/a | n/a | n/a | Local clients and their directory teams (default on first start: dev-clients.yaml in the project; retained for restarts) |
--casework-port <CASEWORK_PORT> | No | No | n/a | n/a | CASEWORKCTL_DEV_CASEWORK_PORT | Casework loopback port on first start (default 8092; retained for restarts) |
--issuer-port <ISSUER_PORT> | No | No | n/a | n/a | CASEWORKCTL_DEV_ISSUER_PORT | Local issuer loopback port on first start (default 8093; retained for restarts) |
--issuer-project <PROJECT> | No | No | n/a | n/a | n/a | Ready Base Registry Engine (BReg) dev project that owns the shared issuer registration |
--database-port <DATABASE_PORT> | No | No | n/a | n/a | CASEWORKCTL_DEV_DATABASE_PORT | PostgreSQL loopback port on first start (default 55433; retained for restarts) |
--source-project <[ID=]PATH> | No | Yes | n/a | n/a | n/a | Running Base Registry Engine (BReg) dev project serving a declared source. This compatibility bridge is available only without explicit integrations or task templates |
--format <FORMAT> | No | No | human | human, json | n/a | Emit the selected command’s report in this format |
-h, --help | No | 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.