Released docs. You are viewing the documentation published with v0.46.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.46.0 and catalog SHA-256 d43b1bf418e0b00fac52311fa3a106fa124512dbc88cf511475713af2d73aa47. 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, event receipts and seed checkpoints; the next start can then take edited inputs. The audit files under .breg/dev/audit are kept |
--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.
Cookies on Registry Stack
We use optional cookies to understand how you use the main Registry Stack website and this documentation. If you contact us, we may link this activity to your enquiry. You can change your choice at any time. Read the privacy policy.
Your browser asks sites not to track you, so optional tracking stays off.
We could not use or save that choice. Optional tracking remains off.