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.30.0 and catalog SHA-256 2221f17eae216048d4cfaf7f66e3dcd68a250f6f6de4e24b177441819192b475. 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 plus its local Registry Mint and Casework children. A project that declares Base Registry Engine sources starts no Mint of its own: pass —source-project and the session borrows the issuer, audience, and clients of the bregctl dev session serving each source. 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) |
--mint-port <MINT_PORT> | No | No | n/a | n/a | CASEWORKCTL_DEV_MINT_PORT | Local Mint loopback port on first start (default 8093; retained for restarts) |
--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 | Base Registry Engine project whose running bregctl dev session serves a declared source, as ID=PATH, or PATH alone when the project declares one source (retained for restarts). The session borrows that registry’s local Mint as its issuer and exports every local client from it |
--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.