Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.26.1.
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.30.0 and catalog SHA-256 2221f17eae216048d4cfaf7f66e3dcd68a250f6f6de4e24b177441819192b475. Hidden implementation commands are omitted.
bregctl [OPTIONS] <COMMAND>Commands
Section titled “Commands”| Command | Description |
|---|---|
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 | Validate a Base Registry Engine authoring project without opening a database |
project | Maintain deterministic authoring project metadata |
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 signing input or publish its externally signed package |
test | Execute the production schema-test journey suite for one unsigned package candidate |
apply | Apply one already signed package using the configured migration authority |
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 |
webhook | Inspect and operate configured webhook deliveries |
request-retention | Inspect and erase eligible change-request retention detail |
evidence-retention | Erase expired protected action Evidence using configured migration authority |
audit | Verify, export, and prune the chained audit journal |
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”Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.