Released docs. You are viewing the documentation published with v0.39.0. Development docs are available at Latest.
messagingctl messages cancel command reference
Cancel a queued message, with —apply.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree for Registry Stack source version 0.39.0 and catalog SHA-256 253866140eb693976375943a07adfce3e3efb9724c0b0fcdff8b37aed3ac7280. Hidden implementation commands are omitted.
messagingctl messages cancel [OPTIONS] --runtime-config <ABSOLUTE_FILE> <MESSAGE_ID>Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<MESSAGE_ID> | Yes | n/a | n/a | n/a | The message id the runtime returned on acceptance |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--runtime-config <ABSOLUTE_FILE> | Yes | n/a | n/a | n/a | Absolute path to the runtime configuration file |
--apply | No | n/a | n/a | n/a | Change the message. Without it, only report what would change |
--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.