bregctl explain command reference
Explain compiled model, access, route, or event inventories.
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.
bregctl explain [OPTIONS] <SUBJECT> [PROJECT]Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<SUBJECT> | Yes | n/a | model, access, routes, queries, actions, proposals, events, lifecycle | n/a | Compiled inventory to explain |
[PROJECT] | No | n/a | n/a | n/a | Base Registry Engine project directory. Required for every subject except lifecycle, which reports engine behaviour no project changes. A symbolic link at any component of this path is refused. |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--production | No | n/a | n/a | n/a | Enforce production-only package closure requirements |
--scenario <JSON_FILE> | No | n/a | n/a | n/a | For access only: bounded JSON with synthetic claims. Performs no token verification or record access. A symbolic link at any component of this path is refused. |
--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.