messagingctl preview command reference
Render one template version with the given data, offline.
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.
messagingctl preview [OPTIONS] --locale <LOCALE> --data <FILE> <--runtime-config <ABSOLUTE_FILE>|--package <DIRECTORY>|--project <DIRECTORY>> <TEMPLATE> <VERSION>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
| Command invocation | Exactly one of --runtime-config <ABSOLUTE_FILE>, --package <DIRECTORY>, --project <DIRECTORY> is required. |
| Command invocation | --package <DIRECTORY> and --project <DIRECTORY> cannot be used together. |
| Command invocation | --package <DIRECTORY> and --runtime-config <ABSOLUTE_FILE> cannot be used together. |
| Command invocation | --project <DIRECTORY> and --runtime-config <ABSOLUTE_FILE> cannot be used together. |
Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<TEMPLATE> | Yes | n/a | n/a | n/a | The template id |
<VERSION> | Yes | n/a | n/a | n/a | The template version |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--runtime-config <ABSOLUTE_FILE> | No | n/a | n/a | n/a | Absolute path to the runtime configuration file |
--package <DIRECTORY> | No | n/a | n/a | n/a | The package directory holding messaging.yaml |
--project <DIRECTORY> | No | n/a | n/a | n/a | Editable authoring project holding messaging.yaml |
--locale <LOCALE> | Yes | n/a | n/a | n/a | A locale the template version declares |
--data <FILE> | Yes | n/a | n/a | n/a | A JSON file holding the template data |
--format <FORMAT> | No | human | human, json | n/a | Emit the selected command’s report in this format |
-h, --help | 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.