bregctl test command reference
Execute the production schema-test journey suite for one unsigned package candidate.
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 test [OPTIONS] --database-id <ID> --runtime-config <ABSOLUTE_FILE> --credentials <ABSOLUTE_FILE> --output <ABSOLUTE_FILE> <PROJECT>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--reviewed-migrations <DIRECTORY> is present | --baseline-runtime-config <ABSOLUTE_FILE> is required. |
Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<PROJECT> | Yes | 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 | Repeatable | Default | Values | Environment | Description |
|---|---|---|---|---|---|---|
--database-id <ID> | Yes | No | n/a | n/a | n/a | Stable deployment database identity recorded in the package |
--baseline-runtime-config <ABSOLUTE_FILE> | No | No | n/a | n/a | n/a | Runtime configuration selecting the verified active baseline for a successor. A symbolic link at any component of this path is refused. |
--reviewed-migrations <DIRECTORY> | No | No | n/a | n/a | n/a | Directory containing reviewed migration descriptors and evidence in package layout. Used identically by test and package; requires a verified baseline. A symbolic link at any component of this path is refused. |
--signature-threshold <COUNT> | No | No | 0 | n/a | n/a | Production signature threshold. Local packages require zero |
--signature-key-id <KEY_ID> | No | Yes | n/a | n/a | n/a | Allowed package-signing key id. Repeat once per trust-anchor key |
--runtime-config <ABSOLUTE_FILE> | Yes | No | n/a | n/a | n/a | Absolute runtime configuration for test database access and secret resolution. A symbolic link at any component of this path is refused. |
--credentials <ABSOLUTE_FILE> | Yes | No | n/a | n/a | n/a | Absolute schema-test credential binding document. A symbolic link at any component of this path is refused. |
--output <ABSOLUTE_FILE> | Yes | No | n/a | n/a | n/a | New canonical schema-test receipt file. A symbolic link at any component of this path is refused. |
--format <FORMAT> | No | No | human | human, json | n/a | Emit the selected command’s report in this format |
-h, --help | No | No | n/a | n/a | n/a | Print help |
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.