Skip to content
Registry StackDocsv0.34.0

registry-render compile command reference

View as Markdown

Render one document offline.

This page is generated from the public Clap command tree for Registry Stack source version 0.34.0 and catalog SHA-256 521175a69262e60df96745886392348e5bb8d82e63cdd24bdf4baa80d46e5ff4. Hidden implementation commands are omitted.

registry-render compile [OPTIONS] --bundle <BUNDLE> --type <DOCUMENT> --data <DATA> --out <OUT>
ConditionRequirement
Command invocation--emit-envelope <EMIT_ENVELOPE> and --watch cannot be used together.
Command invocation--issued-at <ISSUED_AT> and --now cannot be used together.
OptionAlways requiredRepeatableDefaultValuesEnvironmentDescription
--bundle <BUNDLE>YesNon/an/an/aBundle directory
--type <DOCUMENT>YesNon/an/an/aDocument type id, as declared in the manifest
--data <DATA>YesNon/an/an/aJSON file holding the bare data object
--locale <LOCALE>NoNon/an/an/aPrimary locale, recorded in the envelope; must be one the document declares. The template receives every label table either way
--issued-at <ISSUED_AT>NoNon/an/an/aIssuance time; the document’s claim, and the world clock
--nowNoNon/an/an/aUse the current wall clock as issuance time (nondeterministic; loud opt-in for throwaway previews)
--asset <ASSETS>NoYesn/an/an/aAsset name=path, path holding base64 text
--strictNoNon/an/an/aRefuse warnings (missing glyphs and friends)
--timeout <TIMEOUT>NoNon/an/an/aWall-clock budget for the render in seconds; the render is killed at this bound (the same supervised-worker wall serve uses)
--watchNoNon/an/an/aKeep 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>YesNon/an/an/aOutput PDF path
--jsonNoNon/an/an/aMachine-readable result on stdout
--emit-envelope <EMIT_ENVELOPE>NoNon/an/an/aWrite the exact canonical envelope bytes injected into the template to this path (merge-gate and debugging aid)
-h, --helpNoNon/an/an/aPrint help

Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.