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.34.0 and catalog SHA-256 521175a69262e60df96745886392348e5bb8d82e63cdd24bdf4baa80d46e5ff4. 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; —source-project sessions use the running Base Registry Engine (BReg) session’s stock issuer. The database runs the pinned image postgres:17.11@sha256:67f41722b7a8cbdb868a44a4995c846eddfdc2973bccb291ce937dce88ad5675, 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 | 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 (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.