registry-render compile command reference
Render one document offline.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.46.0 and catalog SHA-256 d43b1bf418e0b00fac52311fa3a106fa124512dbc88cf511475713af2d73aa47. Hidden implementation commands are omitted.
registry-render compile [OPTIONS] --bundle <BUNDLE> --type <DOCUMENT> --data <DATA> --output <OUTPUT>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
--signer-name <TEXT> is present | --preview-seal <KIND> is required. |
| Command invocation | --emit-envelope <EMIT_ENVELOPE> and --watch cannot be used together. |
| Command invocation | --issued-at <ISSUED_AT> and --now cannot be used together. |
Options
Section titled “Options”| Option | Always required | Repeatable | Default | Values | Environment | Description |
|---|---|---|---|---|---|---|
--bundle <BUNDLE> | Yes | No | n/a | n/a | n/a | Authored bundle or package directory |
--type <DOCUMENT> | Yes | No | n/a | n/a | n/a | Document type id, as declared in the manifest |
--data <DATA> | Yes | No | n/a | n/a | n/a | JSON file holding the bare data object |
--locale <LOCALE> | No | No | n/a | n/a | n/a | Primary locale, recorded in the envelope; must be one the document declares. The template receives every label table either way |
--issued-at <ISSUED_AT> | No | No | n/a | n/a | n/a | Issuance time; the document’s claim, and the world clock |
--now | No | No | n/a | n/a | n/a | Use the current wall clock as issuance time (nondeterministic; loud opt-in for throwaway previews) |
--asset <ASSETS> | No | Yes | n/a | n/a | n/a | Asset name=path, path holding base64 text |
--strict | No | No | n/a | n/a | n/a | Refuse warnings (missing glyphs and friends) |
--timeout <TIMEOUT> | No | No | n/a | n/a | n/a | Wall-clock budget for the render in seconds; the render is killed at this bound (the same supervised-worker wall serve uses) |
--watch | No | No | n/a | n/a | n/a | Keep rendering on bundle changes (authoring loop; raw source directories are fine, poll-based). Never returns, so it refuses --emit-envelope rather than ignoring it |
--output <OUTPUT> | Yes | No | n/a | n/a | n/a | Output PDF path |
--format <FORMAT> | No | No | human | human, json | n/a | Emit the selected command’s finite report in this format |
--emit-envelope <EMIT_ENVELOPE> | No | No | n/a | n/a | n/a | Write the exact canonical envelope bytes injected into the template to this path (merge-gate and debugging aid) |
--preview-seal <KIND> | No | No | n/a | test-only, production | n/a | Render the template’s sealed variant: add the signing member the seal route adds, as a seal of this kind would. Nothing is signed; the output is the first revision a seal would sign |
--signer-name <TEXT> | No | No | n/a | n/a | n/a | The signing.signerName a seal certificate’s organization (else common name) would give. Without it, the member names no signer |
-h, --help | No | 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.