Released docs. You are viewing the documentation published with v0.34.0. Development docs are available at Latest.
Stop only this project’s supervised services, preserving its database, records, audit history, keys and built package.
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”Stop only this project’s supervised services, preserving its database, records, audit history, keys and built package. Add —remove to also remove the owned container and its data volume, discarding records so the next start can take edited inputs; to change inputs while keeping the records, copy the authored files to a new project directory instead. products/breg/DEV.md documents the full stop and recovery behavior in ‘Retained state and recovery’.
bregctl dev stop [OPTIONS] [PROJECT]Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
[PROJECT] | No | . | n/a | n/a | Registry project whose owned services should stop while preserving records. A symbolic link at any component of this path is refused. |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--remove | No | n/a | n/a | n/a | Also remove the owned container and its data volume, discarding records, audit history, event receipts and seed checkpoints; the next start can then take edited inputs |
--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”Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.