Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.39.0.
messagingctl messages command reference
Read accepted messages, and retry, settle, or cancel one.
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 messages [OPTIONS] <COMMAND>Commands
Section titled “Commands”| Command | Description |
|---|---|
list | List messages, newest first, with the recipient never shown |
show | Show one message with its recipient masked, and its attempts |
retry | Queue a failed message again under a new generation, with —apply |
settle | Settle a message whose outcome is unknown, with —apply |
cancel | Cancel a queued message, with —apply |
Options
Section titled “Options”| Option | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
--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.