registry-render check command reference
Check a bundle or package and a runtime file offline, reporting every finding.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.46.1 and catalog SHA-256 61bebbb88fe15e4da92e2b0adbca0cd5b1a47b8eac38f4b91a15095011368a43. Hidden implementation commands are omitted.
Description
Section titled “Description”Check a bundle or package and a runtime file offline, reporting every finding. Exits 0 when nothing is refused, 1 when something is refused or, under —deny-warnings, a warning is reported, 2 when the command line is invalid, and 3 when an input cannot be read.
registry-render check [OPTIONS]Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--environment is present | --runtime-config <FILE> is required. |
--require-audit-under <ABSOLUTE_DIRECTORY> is present | --runtime-config <FILE> is required. |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--bundle <BUNDLE> | No | n/a | n/a | n/a | Authored bundle or package directory (default: the current directory, unless only —runtime-config is given) |
--runtime-config <FILE> | No | n/a | n/a | n/a | Runtime configuration file |
--environment | No | n/a | n/a | n/a | Fill ${NAME} expressions in the runtime file from the process environment and check the values they produce, reading each seal’s certificate chain file too (never its key). Without it, each expression is checked by syntax and position only, and no chain file is read |
--require-audit-under <ABSOLUTE_DIRECTORY> | No | n/a | n/a | n/a | Prove that the runtime file’s audit file resolves under this absolute directory, the one the deployment mounts as persistent storage. A stdout audit destination is refused. Requires —runtime-config |
--format <FORMAT> | No | human | human, json | n/a | Emit the selected command’s report in this format |
--deny-warnings | No | n/a | n/a | n/a | Exit 1 when a warning is reported |
-h, --help | No | n/a | n/a | n/a | Print help (see a summary with ‘-h’) |
Generation contract
Section titled “Generation contract”After changing a public command, argument, option, default, environment binding, or help description, run cargo run --locked -p registry-cli-docs -- --write, commit crates/registry-cli-docs/catalog.json, then run npm run generate from docs/site.