bregctl check command reference
Check a Base Registry Engine authoring project, package, tool file, or runtime file without opening a database.
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 check [OPTIONS] <PROJECT|--package <DIRECTORY>|--file <FILE>>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
| Command invocation | One or more of [PROJECT], --package <DIRECTORY>, --file <FILE> are required. |
--environment is present | --runtime-config <FILE> is required. |
| Command invocation | --file <FILE> and --package <DIRECTORY> cannot be used together. |
| Command invocation | --file <FILE> and --production cannot be used together. |
| Command invocation | --file <FILE> and --runtime-config <FILE> cannot be used together. |
| Command invocation | --package <DIRECTORY> and --production cannot be used together. |
| Command invocation | --package <DIRECTORY> and --runtime-config <FILE> cannot be used together. |
| Command invocation | --package <DIRECTORY> and [PROJECT] cannot be used together. |
Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
[PROJECT] | No | n/a | n/a | n/a | Base Registry Engine project directory. A symbolic link at any component of this path is refused. |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--package <DIRECTORY> | No | n/a | n/a | n/a | Closed package to verify against its sums, reporting the registry revision it rederives. A symbolic link at any component of this path is refused. |
--file <FILE> | No | n/a | n/a | n/a | One tool file to check on its own, read by its kind: journeys, schema-test credentials or receipt, a data checkpoint or import state, a migration descriptor, rehearsal receipt or backup binding, a model selection, or a development clients, example scenarios, session state or source preparation file. No secret, database, or network is read. With PROJECT, journeys are checked against that project. A symbolic link at any component of this path is refused. |
--production | No | n/a | n/a | n/a | Enforce production-only package closure requirements |
--deny-warnings | No | n/a | n/a | n/a | Exit 1 when a warning is reported |
--runtime-config <FILE> | No | n/a | n/a | n/a | Runtime configuration file. A symbolic link at any component of this path is refused. |
--environment | No | n/a | n/a | n/a | Fill ${NAME} expressions in the runtime file from the process environment and check the values they produce. Without it, each expression is checked by syntax and position only |
--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 |
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.