Registry stack documentation: machine-readable Markdown.
Index of all pages: https://docs.registrystack.org/v/0.38.0/llms.txt
Full corpus: https://docs.registrystack.org/v/0.38.0/llms-full.txt

# messagingctl command reference

> Generated syntax and options for messagingctl.

{/* Generated from Clap command definitions by scripts/generate-cli-reference.mjs. Run npm run generate. */}

Registry Messaging adopter and local operator tooling.

## Contract status

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

## Usage

```text
messagingctl [OPTIONS] <COMMAND>
```

## Commands

| Command | Description |
| --- | --- |
| [`init`](./init/) | Write a starter authoring project and runtime example |
| [`package`](./package/) | Build an immutable runtime package from an editable project |
| [`check`](./check/) | Check an authoring project, installed package, or runtime configuration |
| [`preview`](./preview/) | Render one template version with the given data, offline |
| [`plan`](./plan/) | Report what activating the configured package would change, without writing |
| [`apply`](./apply/) | Apply schema changes and record the configured package as active |
| [`status`](./status/) | Report the active package, activation history, schema, and role mode |
| [`messages`](./messages/) | Read accepted messages, and retry, settle, or cancel one |
| [`retention`](./retention/) | Erase what the retention periods say has expired |
| [`dev`](./dev/) | Run an authoring project locally with PostgreSQL, Mailpit, and a mock HTTP gateway in Docker, until Ctrl-C |

## 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

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