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

CLI reference

Projects commands

sendmock projects create

Add a project that apps can send traffic to by its key.

sendmock projects create [flags]
FlagTypeDescription
--key <key>requiredstring
What apps send as the SMTP username, the X-SendMock-Project header or the /projects/<key>/ URL prefix. It never changes.Example: shop
--name <name>requiredstring
A name for the project, shown in the UI.Example: Shop

Example

sendmock projects create --key shop --name Shop

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

API
POST/api/v1/projects
MCP tool
sendmock_project_create
In the app
Settings > Projects > New project

sendmock projects delete

Delete a project with its emails, SMS and verifications.

sendmock projects delete <projectKey> [flags]
ArgumentTypeDescription
<projectKey>requiredstring
The project's key, from the list of projects.Example: shop
FlagTypeDescription
--yesboolean
Confirms a destructive command; without it the command stops.

Example

sendmock projects delete shop --yes

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

API
DELETE/api/v1/projects/{projectKey}
MCP tool
sendmock_project_delete
In the app
Settings > Projects > Delete

sendmock projects list

Every project, default first, with the traffic each holds.

sendmock projects list

Example

sendmock projects list

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

API
GET/api/v1/projects
MCP tool
sendmock_project_list
In the app
Settings > Projects

sendmock projects update

Rename a project; its key stays the same.

sendmock projects update <projectKey> [flags]
ArgumentTypeDescription
<projectKey>requiredstring
The project's key, from the list of projects.Example: shop
FlagTypeDescription
--name <name>requiredstring
A name for the project, shown in the UI.Example: Shop

Example

sendmock projects update shop --name Shop

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

API
PATCH/api/v1/projects/{projectKey}
MCP tool
sendmock_project_update
In the app
Settings > Projects > Rename