bregctl 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.46.0 and catalog SHA-256 d43b1bf418e0b00fac52311fa3a106fa124512dbc88cf511475713af2d73aa47. 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 and ThunderID containers plus its Base Registry Engine (BReg) child. The database runs the pinned image docker.io/library/postgres:17.11@sha256:67f41722b7a8cbdb868a44a4995c846eddfdc2973bccb291ce937dce88ad5675, the Docker Official Images reference at that digest, or, when the compiled schema requires PostGIS, the Docker Hub image postgis/postgis@sha256:01a6a70e41e6c4467c8f55f6063555ed72db2d6662cd0d571040d42eadaeb6f6, 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 .breg/dev/logs directory. Catchable termination signals trigger owned cleanup, but an uncatchable outside kill can leave surviving service owners that need inspection before restart. products/breg/DEV.md documents this lifecycle in ‘Native local BReg lifecycle’ and its recovery in ‘Retained state and recovery’.
bregctl dev start [OPTIONS] [PROJECT]Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
[PROJECT] | No | . | n/a | n/a | Existing authored registry project. A symbolic link at any component of this path is refused. |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--clients-file <FILE> | No | n/a | n/a | n/a | Local clients, profile bindings, and optional seed records (default on first start: dev-clients.yaml in the project; retained for restarts). A symbolic link at any component of this path is refused. |
--breg-port <BREG_PORT> | No | n/a | n/a | n/a | Registry loopback port on first start (prefers 8090 when available; retained for restarts) |
--issuer-port <ISSUER_PORT> | No | n/a | n/a | n/a | Local issuer loopback port on first start (prefers 8091 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 local issuer and client registrations. A symbolic link at any component of this path is refused. |
--issuer-image <ISSUER_IMAGE> | No | n/a | n/a | n/a | Immutable local candidate issuer image ID on first start; retained for restarts |
--database-port <DATABASE_PORT> | No | n/a | n/a | n/a | PostgreSQL loopback port on first start (prefers 15432 when available; retained for restarts) |
--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 (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.