CLI Reference
MXHook includes a command-line interface for starting the server and managing resources.
Installation
The CLI is part of the mxhook binary. See Binary installation for download and build instructions.
Commands
| Command | Description |
|---|---|
start | Start MXHook services (SMTP + API) |
domain | Manage domains |
route | Manage routing rules |
logs | Tail message lifecycle log |
replay | Re-deliver a message |
status | Show health of all components |
Common Flags
Most commands that interact with the API accept these flags:
| Flag | Default | Description |
|---|---|---|
--api-url | http://localhost:8080 | MXHook API URL |
--api-key | — | API authentication key |
Usage
bash
mxhook <command> [flags]