bregctl package command reference
Build a deterministic production-profile package from a tested candidate.
Contract status
Section titled “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.
Description
Section titled “Description”Build a deterministic production-profile package from a tested candidate. The package is the promotable unit bregctl apply activates: it is built from a project bregctl test passed, so it needs that run’s —test-receipt. caseworkctl package is a different verb that writes a Casework project’s checked policy to its own package.
bregctl package [OPTIONS] --test-receipt <ABSOLUTE_FILE> --output <DIRECTORY> <PROJECT>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--reviewed-migrations <DIRECTORY> is present | --baseline-package <ABSOLUTE_DIRECTORY> 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 | 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. |
--schema-fingerprint <SHA256> | No | n/a | n/a | n/a | Exact managed-catalog SHA-256 produced by the reviewed PostgreSQL rehearsal. Read from the schema-test receipt when it is not supplied |
--test-receipt <ABSOLUTE_FILE> | Yes | n/a | n/a | n/a | Canonical receipt from a successful schema test of this exact candidate. A symbolic link at any component of this path is refused. |
--output <DIRECTORY> | Yes | n/a | n/a | n/a | New build directory that receives the schema-test receipt and the published package/. A symbolic link at any component of this path is refused. |
--revision <TEXT> | No | n/a | n/a | n/a | One printable line recorded in the published package as REVISION |
--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 (see a summary with ‘-h’) |
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.