Preview: SendMock has no stable release yet. These docs follow develop.

CLI reference

Automation commands

sendmock ai install

For each AI agent, the install command and its MCP configuration.

sendmock ai install --target <agent>
FlagTypeDescription
--target <agent>string
Only this agent.One of: claude-code, codex, cursor, gemini, vscodeExample: claude-code

Example

sendmock ai install --target claude-code

Output with --json: AiAgentSetup[]. Exit codes: 0, 1, 2.

API
GET/api/v1/ai/agents
MCP tool
sendmock_ai_agents
In the app
Settings > Connection > AI agents

sendmock ai skill

The SendMock agent skill as Markdown.

sendmock ai skill

Example

sendmock ai skill

Output with --json: file (text/markdown). Exit codes: 0, 1, 2.

API
GET/api/v1/ai/skill
MCP tool
sendmock://docs/skill
In the app
Settings > Connection > AI agents > Download the skill

sendmock events tail

The latest events, newest first: the polling twin of the live stream.

sendmock events tail [flags]

Also runs as sendmock http tail, sendmock webhook tail.

FlagTypeDescription
--since <since>string
Only events newer than this time.Example: 2026-10-26T09:30:00Z
--type <type>string
An event type, e.g. http.captured.Example: http.captured
--limit <limit>integer
At most this many (default 50).Example: 50
--project <project>string
Only events about this project's emails, SMS and verifications (its key); every event when not set.Example: shop

Example

sendmock events tail --since 2026-10-26T09:30:00Z --type http.captured

Output with --json: AppEvent[]. Exit codes: 0, 1, 2.

API
GET/api/v1/events/recent
MCP tool
sendmock_events_recent
In the app
Notification bell

sendmock integrate

Copy-ready settings for a stack, as Settings > Connection shows them.

sendmock integrate <stack> [flags]
ArgumentTypeDescription
<stack>requiredstring
Your app's stack: a language (laravel, node, python, go, java, ruby, dotnet, curl) or a framework (php, express, nestjs, django, flask, fastapi, spring, rails, aspnet).Example: laravel
FlagTypeDescription
--channel <channel>string
email, sms or http (default email).Example: email
--host <host>string
Where the app runs: local, docker-host or compose.Example: local

Example

sendmock integrate laravel --channel email --host local

Output with --json: IntegrationSnippet. Exit codes: 0, 1, 2, 3.

API
GET/api/v1/integrations/{stack}
MCP tool
sendmock_integration_snippet
In the app
Settings > Connection

sendmock scenario run

Run a scenario file step by step and report each step.

sendmock scenario run <file>
ArgumentTypeDescription
<file>requiredpath
A file whose text is sent as scenario: The scenario file's text, in TOML.Example: otp-login.toml

Example

sendmock scenario run otp-login.toml

Output with --json: ScenarioReport. Exit codes: 0, 1, 2.

API
POST/api/v1/scenarios/run
MCP tool
sendmock_scenario_run
In the app
Scenarios > Run

sendmock scenario validate

Check a scenario file without running it.

sendmock scenario validate <file>
ArgumentTypeDescription
<file>requiredpath
A file whose text is sent as scenario: The scenario file's text, in TOML.Example: otp-login.toml

Example

sendmock scenario validate otp-login.toml

Output with --json: ScenarioValidation. Exit codes: 0, 1, 2.

API
POST/api/v1/scenarios/validate
MCP tool
sendmock_scenario_validate
In the app
Scenarios > Validate