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 command reference

> Generated syntax and options for bregctl.

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

Base Registry Engine project checking and deterministic generation.

## 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 [OPTIONS] <COMMAND>
```

## Commands

| Command | Description |
| --- | --- |
| [`init`](./init/) | Create an authoring project in a new directory: a domain-neutral example, one derived from an embedded reference model with `--from`, or a shipped starter with `--template` |
| [`check`](./check/) | Validate a Base Registry Engine authoring project without opening a database |
| [`project`](./project/) | Maintain deterministic authoring project metadata |
| [`module`](./module/) | Add generated modules to an authoring project |
| [`generate`](./generate/) | Write selected compiler artifacts to a new directory |
| [`dev`](./dev/) | Start or stop this project's retained local development services |
| [`examples`](./examples/) | List or explicitly run retained local teaching examples |
| [`explain`](./explain/) | Explain compiled model, access, route, or event inventories |
| [`diff`](./diff/) | Compare an authoring candidate with a rederived closed package |
| [`package`](./package/) | Build a deterministic production-profile package from a tested candidate |
| [`test`](./test/) | Execute the production schema-test journey suite for one package candidate |
| [`apply`](./apply/) | Apply one built package using the configured migration authority |
| [`plan`](./plan/) | Report what `bregctl apply` would activate for one package, running its checks without changing the database |
| [`status`](./status/) | Report the active package and the activation ledger the database records |
| [`doctor`](./doctor/) | Verify configured startup dependencies without binding a listener |
| [`verify`](./verify/) | Verify one configured package without opening runtime dependencies |
| [`migration`](./migration/) | Inspect configured migration lifecycle metadata |
| [`history`](./history/) | Run bounded, audited retained-history maintenance |
| [`data`](./data/) | Validate, import, or export data through authenticated Registry HTTP APIs |
| [`webhook`](./webhook/) | Inspect and operate configured webhook deliveries |
| [`request-retention`](./request-retention/) | Inspect and erase eligible change-request retention detail |
| [`review-recovery`](./review-recovery/) | Recover a lost review or an automatic application blocked by executor authorization |
| [`evidence-retention`](./evidence-retention/) | Erase expired protected action Evidence using configured migration authority |
| [`import-authority`](./import-authority/) | Open, close, and list the authorities that bound `import` runs |
| [`instance-claim`](./instance-claim/) | Inspect and adopt the claim naming the database the Registry serves from |
| [`field-encryption`](./field-encryption/) | Maintain field-encryption key material |

## Options

| Option | Always required | Default | Values | Environment | Description |
| --- | --- | --- | --- | --- | --- |
| `--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 |
| `-V, --version` | No | n/a | n/a | n/a | Print version |

## Generation contract

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