bregctl test command reference
Execute the production schema-test journey suite for one package candidate.
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 test [OPTIONS] --runtime-config <ABSOLUTE_FILE> <PROJECT>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--reviewed-migrations <DIRECTORY> is present | --baseline-package <ABSOLUTE_DIRECTORY> is required. |
| Command invocation | --baseline-package <ABSOLUTE_DIRECTORY> and --fingerprint-only cannot be used together. |
| Command invocation | --credentials <ABSOLUTE_FILE> and --fingerprint-only cannot be used together. |
| Command invocation | --fingerprint-only and --output <ABSOLUTE_FILE> cannot be used together. |
| Command invocation | --fingerprint-only and --reviewed-migrations <DIRECTORY> cannot be used together. |
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 | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--baseline-package <ABSOLUTE_DIRECTORY> | No | n/a | n/a | n/a | Absolute directory of the chain tip package a successor follows. The same package directory is named in every environment. A symbolic link at any component of this path is refused. |
--reviewed-migrations <DIRECTORY> | 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 baseline package. A symbolic link at any component of this path is refused. |
--runtime-config <ABSOLUTE_FILE> | Yes | n/a | n/a | n/a | Runtime configuration file. A symbolic link at any component of this path is refused. |
--credentials <ABSOLUTE_FILE> | No | n/a | n/a | n/a | Absolute schema-test credential binding document. Required unless —fingerprint-only is given. A symbolic link at any component of this path is refused. |
--output <ABSOLUTE_FILE> | No | n/a | n/a | n/a | New canonical schema-test receipt file. Required unless —fingerprint-only is given. A symbolic link at any component of this path is refused. |
--fingerprint-only | No | n/a | n/a | n/a | Only measure the schema fingerprint a fresh install of the candidate produces, the target a reviewed migration declares. Runs no fixtures and writes no receipt |
--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.