caseworkctl dev start command reference
Start or reuse the project’s retained local database and services.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.45.0 and catalog SHA-256 18546dbdf436972522108829ab0f8c804142a7474cfe3841e0b8ff10e061c842. Hidden implementation commands are omitted.
Description
Section titled “Description”Start or reuse the project’s retained local database and services. A resident supervisor owns this project’s PostgreSQL container and Casework child. Standalone sessions also own a pinned issuer container; —issuer-project borrows a separately running Base Registry Engine (BReg) session’s registered issuer. The database runs the pinned image docker.io/library/postgres:17.11@sha256:67f41722b7a8cbdb868a44a4995c846eddfdc2973bccb291ce937dce88ad5675, the Docker Official Images reference at that digest, which the supervisor pulls on the first start. Each supervised prerequisite command may run for 120 seconds, and the database and each started service have 45 seconds to answer as ready. A start that passes a deadline fails, stops what it acquired, and keeps its owner-only diagnostics in the project’s private .casework/dev/logs directory.
caseworkctl dev start [OPTIONS] [PROJECT]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 | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--clients-file <FILE> | 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 | n/a | n/a | CASEWORKCTL_DEV_CASEWORK_PORT | Casework loopback port on first start (prefers 8092 when available; retained for restarts) |
--issuer-port <ISSUER_PORT> | No | n/a | n/a | CASEWORKCTL_DEV_ISSUER_PORT | Local issuer loopback port on first start (prefers 8093 when available; retained for restarts) |
--issuer-project <PROJECT> | 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 | n/a | n/a | CASEWORKCTL_DEV_DATABASE_PORT | PostgreSQL loopback port on first start (prefers 15433 when available; retained for restarts) |
--format <FORMAT> | No | human | human, json | n/a | Write human diagnostics and reports, or one typed JSON report |
-h, --help | No | n/a | n/a | n/a | Print help (see a summary with ‘-h’) |
Generation contract
Section titled “Generation contract”After changing a public command, argument, option, default, environment binding, or help description, run cargo run --locked -p registry-cli-docs -- --write, commit crates/registry-cli-docs/catalog.json, then run npm run generate from docs/site.