bregctl plan command reference
Report what bregctl apply would activate for one package, running its checks without changing the database.
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”Report what bregctl apply would activate for one package, running its checks without changing the database. A plan uses the migration credential, because apply’s checks read what only the migration role may read. It rolls back every check it runs, appends no audit entry, and holds the apply lock while it checks. Pending changes exit 0; a refusal exits 1 and names the fix.
bregctl plan [OPTIONS] --runtime-config <ABSOLUTE_FILE> --package <ABSOLUTE_DIRECTORY>Options
Section titled “Options”| Option | Always required | Repeatable | Default | Values | Environment | Description |
|---|---|---|---|---|---|---|
--runtime-config <ABSOLUTE_FILE> | Yes | No | n/a | n/a | n/a | Absolute runtime configuration for deployment identity, roles, and database access. A symbolic link at any component of this path is refused. |
--package <ABSOLUTE_DIRECTORY> | Yes | No | n/a | n/a | n/a | Absolute target package directory. A symbolic link at any component of this path is refused. |
--backup <BINDING_PATH=BINDING_FILE> | No | Yes | n/a | n/a | n/a | Reviewed backup binding to verify as apply would, as BINDING_PATH=BINDING_FILE; without it, the plan lists the bindings apply requires |
--format <FORMAT> | No | No | human | human, json | n/a | Emit the selected command’s report in this format |
-h, --help | No | 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.