Resend CLI
Installation
Before running any resend commands, check whether the CLI is installed:
resend --version
If the command is not found, install it using one of the methods below:
cURL (macOS / Linux):
curl -fsSL https://resend.com/install.sh | bash
Homebrew (macOS / Linux):
brew install resend/cli/resend
Node.js:
npm install -g resend-cli
PowerShell (Windows):
irm https://resend.com/install.ps1 | iex
After installing, verify:
resend --version
Agent Protocol
The CLI auto-detects non-TTY environments and outputs JSON — no --json flag needed.
Rules for agents:
Authentication
Auth resolves: --api-key flag > RESEND_API_KEY env > config file (resend login --key). Use --profile or RESEND_PROFILE for multi-profile.
Global Flags
| Flag |
Description |
--api-key <key> |
Override API key for this invocation |
-p, --profile <name> |
Select stored profile |
--json |
Force JSON output (auto in non-TTY) |
-q, --quiet |
Suppress spinners/status (implies --json) |
Available Commands
| Command Group |
What it does |
emails |
send, get, list, batch, cancel, update |
emails receiving |
list, get, attachments, forward, listen |
domains |
create, verify, update, delete, list |
logs |
list, get, open |
api-keys |
create, list, delete |
broadcasts |
create, send, update, delete, list |
contacts |
create, update, delete, segments, topics |
contact-properties |
create, update, delete, list |
segments |
create, get, list, delete |
templates |
create, publish, duplicate, delete, list |
topics |
create, update, delete, list |
webhooks |
create, update, listen, delete, list |
auth |
login, logout, switch, rename, remove |
whoami / doctor / update / open |
Utility commands |
Read the matching reference file for detailed flags and output shapes.
Common Mistakes
| # |
Mistake |
Fix |
| 1 |
Forgetting --yes on delete commands |
All delete/rm subcommands require --yes in non-interactive mode — otherwise the CLI exits with an error |
| 2 |
Not saving webhook signing_secret |
webhooks create shows the secret once only — it cannot be retrieved later. Capture it from command output immediately |
| 3 |
Omitting --quiet in CI |
Without -q, spinners and status text leak into stdout. Use -q to get clean JSON only |
| 4 |
Using --scheduled-at with batch |
Batch sending does not support scheduled_at — use single emails send instead |
| 5 |
Expecting domains list to include DNS records |
List returns summaries only — use domains get <id> for the full records[] array |
| 6 |
Sending a dashboard-created broadcast via CLI |
Only API-created broadcasts can be sent with broadcasts send — dashboard broadcasts must be sent from the dashboard |
| 7 |
Passing --events to webhooks update expecting additive behavior |
--events replaces the entire subscription list — always pass the complete set |
| 8 |
Expecting logs list to include request/response bodies |
List returns summary fields only — use logs get <id> for full request_body and response_body |
Common Patterns
Send an email:
resend emails send --from "you@domain.com" --to user@example.com --subject "Hello" --text "Body"
Send a React Email template (.tsx):
resend emails send --from "you@domain.com" --to user@example.com --subject "Welcome" --react-email ./emails/welcome.tsx
Domain setup flow:
resend domains create --name example.com --region us-east-1
# Configure DNS records from output, then:
resend domains verify <domain-id>
resend domains get <domain-id> # check status
Create and send a broadcast:
resend broadcasts create --from "news@domain.com" --subject "Update" --segment-id <id> --html "<h1>Hi</h1>" --send
CI/CD (no login needed):
RESEND_API_KEY=re_xxx resend emails send --from ... --to ... --subject ... --text ...
Check environment health:
resend doctor -q
When to Load References
- Sending or reading emails → references/emails.md
- Setting up or verifying a domain → references/domains.md
- Managing API keys → references/api-keys.md
- Creating or sending broadcasts → references/broadcasts.md
- Managing contacts, segments, or topics → references/contacts.md, references/segments.md, references/topics.md
- Defining contact properties → references/contact-properties.md
- Working with templates → references/templates.md
- Viewing API request logs → references/logs.md
- Setting up webhooks or listening for events → references/webhooks.md
- Auth, profiles, or health checks → references/auth.md
- Multi-step recipes (setup, CI/CD, broadcast workflow) → references/workflows.md
- Command failed with an error → references/error-codes.md
- Resend SDK integration (Node.js, Python, Go, etc.) → Install the
resend skill
- AI agent email inbox → Install the
agent-email-inbox skill
1---2name: resend-cli3description: >4 Operate the Resend platform from the terminal — send emails (including React Email5 .tsx templates via --react-email), manage domains, contacts, broadcasts, templates,6 webhooks, API keys, and logs via the `resend` CLI. Use when the user wants to run7 Resend commands in the shell, scripts, or CI/CD pipelines, or send/preview React8 Email templates. Always load this skill before running `resend` commands — it9 contains the non-interactive flag contract and gotchas that prevent silent failures.10license: MIT11metadata:12 author: resend13 version: "1.9.0"14 homepage: https://resend.com15 source: https://skillmd.com/skills/bishal-pdmsft/resend-cli16 upstream: https://github.com/resend/resend-cli17inputs:18 - name: RESEND_API_KEY19 description: Resend API key for authenticating CLI commands. Get yours at https://resend.com/api-keys20 required: true21references:22 - references/emails.md23 - references/domains.md24 - references/api-keys.md25 - references/broadcasts.md26 - references/contacts.md27 - references/contact-properties.md28 - references/segments.md29 - references/templates.md30 - references/topics.md31 - references/logs.md32 - references/webhooks.md33 - references/auth.md34 - references/workflows.md35 - references/error-codes.md36---3738# Resend CLI3940## Installation4142Before running any `resend` commands, check whether the CLI is installed:4344```bash45resend --version46```4748If the command is not found, install it using one of the methods below:4950**cURL (macOS / Linux):**51```bash52curl -fsSL https://resend.com/install.sh | bash53```5455**Homebrew (macOS / Linux):**56```bash57brew install resend/cli/resend58```5960**Node.js:**61```bash62npm install -g resend-cli63```6465**PowerShell (Windows):**66```powershell67irm https://resend.com/install.ps1 | iex68```6970After installing, verify:71```bash72resend --version73```7475## Agent Protocol7677The CLI auto-detects non-TTY environments and outputs JSON — no `--json` flag needed.7879**Rules for agents:**80- Supply ALL required flags. The CLI will NOT prompt when stdin is not a TTY.81- Pass `--quiet` (or `-q`) to suppress spinners and status messages.82- Exit `0` = success, `1` = error.83- Error JSON goes to stderr, success JSON goes to stdout:84 ```json85 {"error":{"message":"...","code":"..."}}86 ```87- Use `--api-key` or `RESEND_API_KEY` env var. Never rely on interactive login.88- All `delete`/`rm` commands require `--yes` in non-interactive mode.8990## Authentication9192Auth resolves: `--api-key` flag > `RESEND_API_KEY` env > config file (`resend login --key`). Use `--profile` or `RESEND_PROFILE` for multi-profile.9394## Global Flags9596| Flag | Description |97|------|-------------|98| `--api-key <key>` | Override API key for this invocation |99| `-p, --profile <name>` | Select stored profile |100| `--json` | Force JSON output (auto in non-TTY) |101| `-q, --quiet` | Suppress spinners/status (implies `--json`) |102103## Available Commands104105| Command Group | What it does |106|--------------|-------------|107| `emails` | send, get, list, batch, cancel, update |108| `emails receiving` | list, get, attachments, forward, listen |109| `domains` | create, verify, update, delete, list |110| `logs` | list, get, open |111| `api-keys` | create, list, delete |112| `broadcasts` | create, send, update, delete, list |113| `contacts` | create, update, delete, segments, topics |114| `contact-properties` | create, update, delete, list |115| `segments` | create, get, list, delete |116| `templates` | create, publish, duplicate, delete, list |117| `topics` | create, update, delete, list |118| `webhooks` | create, update, listen, delete, list |119| `auth` | login, logout, switch, rename, remove |120| `whoami` / `doctor` / `update` / `open` | Utility commands |121122Read the matching reference file for detailed flags and output shapes.123124## Common Mistakes125126| # | Mistake | Fix |127|---|---------|-----|128| 1 | **Forgetting `--yes` on delete commands** | All `delete`/`rm` subcommands require `--yes` in non-interactive mode — otherwise the CLI exits with an error |129| 2 | **Not saving webhook `signing_secret`** | `webhooks create` shows the secret once only — it cannot be retrieved later. Capture it from command output immediately |130| 3 | **Omitting `--quiet` in CI** | Without `-q`, spinners and status text leak into stdout. Use `-q` to get clean JSON only |131| 4 | **Using `--scheduled-at` with batch** | Batch sending does not support `scheduled_at` — use single `emails send` instead |132| 5 | **Expecting `domains list` to include DNS records** | List returns summaries only — use `domains get <id>` for the full `records[]` array |133| 6 | **Sending a dashboard-created broadcast via CLI** | Only API-created broadcasts can be sent with `broadcasts send` — dashboard broadcasts must be sent from the dashboard |134| 7 | **Passing `--events` to `webhooks update` expecting additive behavior** | `--events` replaces the entire subscription list — always pass the complete set |135| 8 | **Expecting `logs list` to include request/response bodies** | List returns summary fields only — use `logs get <id>` for full `request_body` and `response_body` |136137## Common Patterns138139**Send an email:**140```bash141resend emails send --from "you@domain.com" --to user@example.com --subject "Hello" --text "Body"142```143144**Send a React Email template (.tsx):**145```bash146resend emails send --from "you@domain.com" --to user@example.com --subject "Welcome" --react-email ./emails/welcome.tsx147```148149**Domain setup flow:**150```bash151resend domains create --name example.com --region us-east-1152# Configure DNS records from output, then:153resend domains verify <domain-id>154resend domains get <domain-id> # check status155```156157**Create and send a broadcast:**158```bash159resend broadcasts create --from "news@domain.com" --subject "Update" --segment-id <id> --html "<h1>Hi</h1>" --send160```161162**CI/CD (no login needed):**163```bash164RESEND_API_KEY=re_xxx resend emails send --from ... --to ... --subject ... --text ...165```166167**Check environment health:**168```bash169resend doctor -q170```171172## When to Load References173174- **Sending or reading emails** → [references/emails.md](references/emails.md)175- **Setting up or verifying a domain** → [references/domains.md](references/domains.md)176- **Managing API keys** → [references/api-keys.md](references/api-keys.md)177- **Creating or sending broadcasts** → [references/broadcasts.md](references/broadcasts.md)178- **Managing contacts, segments, or topics** → [references/contacts.md](references/contacts.md), [references/segments.md](references/segments.md), [references/topics.md](references/topics.md)179- **Defining contact properties** → [references/contact-properties.md](references/contact-properties.md)180- **Working with templates** → [references/templates.md](references/templates.md)181- **Viewing API request logs** → [references/logs.md](references/logs.md)182- **Setting up webhooks or listening for events** → [references/webhooks.md](references/webhooks.md)183- **Auth, profiles, or health checks** → [references/auth.md](references/auth.md)184- **Multi-step recipes** (setup, CI/CD, broadcast workflow) → [references/workflows.md](references/workflows.md)185- **Command failed with an error** → [references/error-codes.md](references/error-codes.md)186- **Resend SDK integration** (Node.js, Python, Go, etc.) → Install the [`resend`](https://github.com/resend/resend-skills) skill187- **AI agent email inbox** → Install the [`agent-email-inbox`](https://github.com/resend/resend-skills) skill