Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.39.0.
Serve the citizen review page for Base Registry Engine change requests.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.40.0 and catalog SHA-256 42b4f89103fb6b0fc57282f99a8d8ab8fc777b3c745d6243720ff4a99ba1f57f. Hidden implementation commands are omitted.
breg-review --runtime-config <FILE> <COMMAND>Commands
Section titled “Commands”| Command | Description |
|---|---|
check | Validate the runtime configuration and resolve its secrets without opening a socket |
serve | Serve the review page until it is terminated |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--runtime-config <FILE> | Yes | n/a | n/a | n/a | Absolute path to the review page runtime configuration |
-h, --help | No | n/a | n/a | n/a | Print help |
-V, --version | No | n/a | n/a | n/a | Print version |
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.