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.34.0 and catalog SHA-256 c9eb944fbb64b3beca0250dc0dee945ea12d5c5f92ffeab2f7c21d9eeb888c6c. Hidden implementation commands are omitted.
registry-render compile [OPTIONS] --bundle <BUNDLE> --type <DOCUMENT> --data <DATA> --out <OUT>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
| 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 | Bundle 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; unsealed bundles are fine, poll-based). Never returns, so it refuses --emit-envelope rather than ignoring it |
--out <OUT> | Yes | No | n/a | n/a | n/a | Output PDF path |
--json | No | No | n/a | n/a | n/a | Machine-readable result on stdout |
--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) |
-h, --help | No | 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.