bregctl command reference
Base Registry Engine project checking and deterministic generation.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.45.0 and catalog SHA-256 18546dbdf436972522108829ab0f8c804142a7474cfe3841e0b8ff10e061c842. Hidden implementation commands are omitted.
bregctl [OPTIONS] <COMMAND>Commands
Section titled “Commands”| Command | Description |
|---|---|
api | Send one raw HTTP request to a configured or ready local Base Registry Engine |
connection | Manage named Base Registry Engine API connections |
serve | Run the production Base Registry Engine service with the selected runtime |
mcp | Operate the optional citizen-facing MCP gateway |
review | Operate the optional citizen review page |
init | Create an authoring project in a new directory: a domain-neutral example, one derived from an embedded reference model with --from, or a shipped starter with --template |
check | Check a Base Registry Engine authoring project, package, tool file, or runtime file without opening a database |
project | Maintain deterministic authoring project metadata |
module | Add generated modules to an authoring project |
generate | Write selected compiler artifacts to a new directory |
dev | Start or stop this project’s retained local development services |
examples | List or explicitly run retained local teaching examples |
explain | Explain compiled model, access, route, or event inventories |
diff | Compare an authoring candidate with a rederived closed package |
package | Build a deterministic production-profile package from a tested candidate |
test | Execute the production schema-test journey suite for one package candidate |
apply | Apply one built package using the configured migration authority |
plan | Report what bregctl apply would activate for one package, running its checks without changing the database |
status | Report the active package and the activation ledger the database records |
timer | Inspect and operate native Record timers through bounded audited commands |
doctor | Verify configured startup dependencies without binding a listener |
verify | Verify one configured package without opening runtime dependencies |
migration | Inspect configured migration lifecycle metadata |
history | Run bounded, audited retained-history maintenance |
data | Validate, import, or export data through authenticated Registry HTTP APIs |
statistics | Publish or withdraw statistical releases through authenticated Registry HTTP APIs |
hook | Inspect and operate configured hook deliveries |
proposal-retention | Inspect and erase eligible Proposal retention detail |
review-recovery | Recover a lost review or an automatic application blocked by executor authorization |
evidence-retention | Erase expired protected action Evidence using configured migration authority |
idempotency-retention | Drop held idempotency responses past their receipt horizon using configured migration authority |
import-authority | Open, close, and list the authorities that bound import runs |
instance-claim | Inspect and adopt the claim naming the database the Registry serves from |
field-encryption | Maintain field-encryption key material |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--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 |
-V, --version | No | n/a | n/a | n/a | Print version |
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.