Registry stack documentation: machine-readable Markdown.
Index of all pages: https://docs.registrystack.org/v/0.38.0/llms.txt
Full corpus: https://docs.registrystack.org/v/0.38.0/llms-full.txt

# bregctl test command reference

> Generated syntax and options for bregctl test.

{/* Generated from Clap command definitions by scripts/generate-cli-reference.mjs. Run npm run generate. */}

Execute the production schema-test journey suite for one package candidate.

## Contract status

This page is generated from the public Clap command tree for Registry Stack source version `0.38.0` and catalog SHA-256 `cd13c658f65af295f9df3c6db86dc045ac06e9e040afc1f5f5b27c3184ab653d`. Hidden implementation commands are omitted.

## Usage

```text
bregctl test [OPTIONS] --runtime-config <ABSOLUTE_FILE> --credentials <ABSOLUTE_FILE> --output <ABSOLUTE_FILE> <PROJECT>
```

## Constraints

| Condition | Requirement |
| --- | --- |
| `--reviewed-migrations <DIRECTORY>` is present | `--baseline-package <ABSOLUTE_DIRECTORY>` is required. |

## 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

| 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 | 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 | 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 | 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 | `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

Run `npm run generate` from `docs/site` after changing a public command, argument, option, default, environment binding, or help description.