Resend 的官方 CLI
The official CLI for Resend.
Built for humans, AI agents, and CI/CD pipelines.
██████╗ ███████╗███████╗███████╗███╗ ██╗██████╗
██╔══██╗██╔════╝██╔════╝██╔════╝████╗ ██║██╔══██╗
██████╔╝█████╗ ███████╗█████╗ ██╔██╗ ██║██║ ██║
██╔══██╗██╔══╝ ╚════██║██╔══╝ ██║╚██╗██║██║ ██║
██║ ██║███████╗███████║███████╗██║ ╚████║██████╔╝
╚═╝ ╚═╝╚══════╝╚══════╝╚══════╝╚═╝ ╚═══╝╚═════╝curl -fsSL https://resend.com/install.sh | bashnpm install -g resend-clibrew install resend/cli/resendirm https://resend.com/install.ps1 | iexOr download the .exe directly from the GitHub releases page.
# Authenticate
resend login
# Send an email
resend emails send \
--from "[email protected]" \
--to [email protected] \
--subject "Hello from Resend CLI" \
--text "Sent from my terminal."
# Check your environment
resend doctorThis CLI ships with an agent skill that teaches AI coding agents (Cursor, Claude Code, Windsurf, etc.) how to use the Resend CLI effectively, including non-interactive flags, output formats, and common pitfalls.
To install skills for Resend's full platform (API, CLI, React Email, email best practices) from the central skills repository:
npx skills add resend/resend-skillsUse this when you want to change the CLI and run your build locally.
Clone the repo
git clone https://github.com/resend/resend-cli.git
cd resend-cliInstall dependencies
pnpm installBuild locally
pnpm buildOutput: ./dist/cli.cjs
Use the dev script:
pnpm dev --versionOr run the built JS bundle:
node dist/cli.cjs --versionAfter editing source files, rebuild:
pnpm buildTo build a standalone native binary:
pnpm build:binOutput: ./dist/resend
The CLI resolves your API key using the following priority chain:
| Priority | Source | How to set |
|---|---|---|
| 1 (highest) | --api-key flag |
resend --api-key re_xxx emails send ... |
| 2 | RESEND_API_KEY env var |
export RESEND_API_KEY=re_xxx |
| 3 (lowest) | Config file | resend login |
If no key is found from any source, the CLI errors with code auth_error.
resend loginAuthenticate by storing your API key locally. The key is validated against the Resend API before being saved.
resend loginWhen run in a terminal, the command checks for an existing key:
env, config) and prompts for a new key to replace it.Enter the key via a masked password input. Your key must start with re_.
When stdin is not a TTY, the --key flag is required:
resend login --key re_xxxxxxxxxxxxxOmitting --key in non-interactive mode exits with error code missing_key.
| Flag | Description |
|---|---|
--key |
API key to store (required in non-interactive mode) |
On success, credentials are saved to ~/.config/resend/credentials.json with 0600 permissions (owner read/write only). The config directory is created with 0700 permissions.
# JSON output
resend login --key re_xxx --json
# => {"success":true,"config_path":"/Users/you/.config/resend/credentials.json"}| Code | Cause |
|---|---|
missing_key |
No --key provided in non-interactive mode |
invalid_key_format |
Key does not start with re_ |
validation_failed |
Resend API rejected the key |
If you work across multiple Resend teams or accounts, the CLI handles that, too.
Switch between profiles without logging in and out:
resend auth switchYou can also use the global --profile (or -p) flag on any command to run it with a specific profile.
resend domains list --profile productionresend emails sendSend an email via the Resend API.
Provide all options via flags for scripting, or let the CLI prompt interactively for missing fields.
resend emails send \
--from "Name " \
--to [email protected] \
--subject "Subject line" \
--text "Plain text body"| Flag | Required | Description |
|---|---|---|
--from |
Yes | Sender email address (must be from a verified domain) |
--to |
Yes | One or more recipient email addresses (space-separated) |
--subject |
Yes | Email subject line |
--text |
One of text/html/html-file | Plain text body |
--html |
One of text/html/html-file | HTML body as a string |
--html-file |
One of text/html/html-file | Path to an HTML file to use as body |
--cc |
No | CC recipients (space-separated) |
--bcc |
No | BCC recipients (space-separated) |
--reply-to |
No | Reply-to email address |
When run in a terminal without all required flags, the CLI prompts for missing fields:
# prompts for from, to, subject, and body
resend emails send
# prompts only for missing fields
resend emails send --from "[email protected]"When piped or run in CI, all required flags must be provided. Missing flags cause an error listing what's needed:
echo "" | resend emails send --from "[email protected]"
# Error: Missing required flags: --to, --subjectA body (--text, --html, or --html-file) is also required — omitting all three exits with code missing_body.
Multiple recipients:
resend emails send \
--from "[email protected]" \
--to [email protected] [email protected] \
--subject "Team update" \
--text "Hello everyone"HTML from a file:
resend emails send \
--from "[email protected]" \
--to [email protected] \
--subject "Newsletter" \
--html-file ./newsletter.htmlWith CC, BCC, and reply-to:
resend emails send \
--from "[email protected]" \
--to [email protected] \
--subject "Meeting notes" \
--text "See attached." \
--cc [email protected] \
--bcc [email protected] \
--reply-to [email protected]Overriding the API key for one send:
resend --api-key re_other_key emails send \
--from "[email protected]" \
--to [email protected] \
--subject "Test" \
--text "Using a different key"Returns the email ID on success:
{ "id": "49a3999c-0ce1-4ea6-ab68-afcd6dc2e794" }| Code | Cause |
|---|---|
auth_error |
No API key found or client creation failed |
missing_body |
No --text, --html, or --html-file provided |
file_read_error |
Could not read the file passed to --html-file |
send_error |
Resend API returned an error |
resend doctorRun environment diagnostics. Verifies your CLI version, API key, domains, and detects AI agent integrations.
resend doctor| Check | Pass | Warn | Fail |
|---|---|---|---|
| CLI Version | Running latest | Update available or registry unreachable | — |
| API Key | Key found (shows masked key and source) | — | No key found |
| Domains | Verified domains exist | No domains or all pending verification | API key invalid |
| AI Agents | Lists detected agents (or none) | — | — |
The API key is always masked in output (e.g. re_...xxxx).
In a terminal, shows animated spinners for each check with colored status icons:
Resend Doctor
✔ CLI Version: v0.1.0 (latest)
✔ API Key: re_...xxxx (source: env)
✔ Domains: 2 verified, 0 pending
✔ AI Agents: Detected: Cursor, Claude Desktopresend doctor --json{
"ok": true,
"checks": [
{ "name": "CLI Version", "status": "pass", "message": "v0.1.0 (latest)" },
{
"name": "API Key",
"status": "pass",
"message": "re_...xxxx (source: env)"
},
{ "name": "Domains", "status": "pass", "message": "2 verified, 0 pending" },
{ "name": "AI Agents", "status": "pass", "message": "Detected: Cursor" }
]
}Each check has a status of pass, warn, or fail. The top-level ok is false if any check is fail.
| Agent | Detection method |
|---|---|
| OpenClaw | ~/clawd/skills directory exists |
| Cursor | ~/.cursor directory exists |
| Claude Desktop | Platform-specific config file exists |
| VS Code | .vscode/mcp.json in current directory |
Exits 0 when all checks pass or warn. Exits 1 if any check fails.
With the Resend CLI, you can manage webhook endpoints so your app receives real-time event notifications.
Payloads are signed with Svix headers (svix-id, svix-timestamp, svix-signature). Verify them in your app with the Resend SDK.
For example: resend.webhooks.verify({ payload, headers, webhookSecret })
There are many events that you can listen for in your application.
For example, you can:
contact.created event.email.received webhook to set up an inbox for your agent and notify it when a new email is received.| Category | Events | |
暂无开放 Issues,或尚未同步最近议题。