Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.26.1.
bregctl field-encryption preflight command reference
Report what one reviewed backfill apply would do, before running it: value-free counts per covered field, the descriptor’s explicit history choice, and the record names a unique blind index would refuse.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.34.0 and catalog SHA-256 c9eb944fbb64b3beca0250dc0dee945ea12d5c5f92ffeab2f7c21d9eeb888c6c. Hidden implementation commands are omitted.
bregctl field-encryption preflight [OPTIONS] --runtime-config <ABSOLUTE_FILE> --package <ABSOLUTE_DIRECTORY>Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--runtime-config <ABSOLUTE_FILE> | Yes | n/a | n/a | n/a | Absolute Base Registry Engine runtime configuration file. A symbolic link at any component of this path is refused. |
--package <ABSOLUTE_DIRECTORY> | Yes | n/a | n/a | n/a | Absolute directory of the verified successor package the operator plans to apply. 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
Section titled “Generation contract”Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.