Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.39.0.
Registry Messaging adopter and local operator tooling.
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 [OPTIONS] <COMMAND>Commands
Section titled “Commands”| Command | Description |
|---|---|
init | Write a starter authoring project and runtime example |
package | Build an immutable runtime package from an editable project |
check | Check an authoring project, installed package, or runtime configuration |
preview | Render one template version with the given data, offline |
plan | Report what activating the configured package would change, without writing |
apply | Apply schema changes and record the configured package as active |
status | Report the active package, activation history, schema, and role mode |
messages | Read accepted messages, and retry, settle, or cancel one |
retention | Erase what the retention periods say has expired |
dev | Run an authoring project locally with PostgreSQL, Mailpit, and a mock HTTP gateway in Docker, until Ctrl-C |
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 |
-V, --version | No | n/a | n/a | n/a | Print version |
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.