Resend CLI

インストール

resend コマンドを実行する前に、CLIがインストールされているか確認してください：

resend --version

コマンドが見つからない場合は、以下のいずれかの方法でインストールしてください：

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

インストール後、確認してください：

resend --version

Agent プロトコル

CLIは非TTY環境を自動で検出し、JSONを出力します — --json フラグは不要です。

エージェント向けルール：

• すべての必須フラグを指定してください。stdinがTTYでない場合、CLIはプロンプトを表示しません。
• --quiet （または -q）を渡してスピナーとステータスメッセージを抑止します。
• Exit 0 = 成功、1 = エラー。
• エラーJSONはstderr、成功JSONはstdoutに出力されます：

  {"error":{"message":"...","code":"..."}}
  

• --api-key またはRESEND_API_KEY環境変数を使用します。インタラクティブログインには頼りません。
• すべての delete/rm コマンドは非インタラクティブモードで --yes が必須です。

認証

認証の解決順序：--api-key フラグ > RESEND_API_KEY 環境変数 > 設定ファイル（resend login --key）。マルチプロファイルには --profile または RESEND_PROFILE を使用します。

グローバルフラグ

フラグ	説明
--api-key <key>	このコマンド実行時のAPIキーを上書き
-p, --profile <name>	保存されたプロファイルを選択
--json	JSONOutput を強制（非TTYで自動）
-q, --quiet	スピナー/ステータスを抑止（--json を示唆）

利用可能なコマンド

コマンドグループ	機能
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
automations	create, get, list, update, delete, stop, open, runs
events	create, get, list, update, delete, send, open
broadcasts	create, send, update, delete, list
contacts	create, update, delete, segments, topics
contact-properties	create, update, delete, list
segments	create, get, list, delete, contacts
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 / commands	ユーティリティコマンド

詳細なフラグと出力形式は、対応するリファレンスファイルを参照してください。

ドライラン： emails send と broadcasts create のみが --dry-run をサポート（送信/作成前のペイロード検証）。APIを呼ばずに { "dryRun": true, "request": { ... } } をstdoutに出力します。emails batch、broadcasts send その他のコマンドには --dry-run はまだありません。

よくある誤り

#	誤り	対応
1	deleteコマンドで --yes を忘れる	すべての delete/rm サブコマンドは非インタラクティブモードで --yes が必須 — なければCLIはエラーで終了します
2	ウェブフック signing_secret を保存しない	webhooks create はシークレットを一度だけ表示 — 後で取得することはできません。コマンド出力から直ちにキャプチャしてください
3	CI で --quiet を省略する	-q がないと、スピナーとステータステキストはstderr に出力されます（stdoutではなく）。stdoutにJSONを出し、stderrにスピナーノイズをなくすため -q を使用してください
4	--scheduled-at をバッチで使用する	バッチ送信は scheduled_at をサポートしません — 代わりに単一の emails send を使用してください
5	domains list にDNSレコードが含まれると期待する	ListはサマリーのみReturnします — 完全な records[] 配列には domains get <id> を使用してください
6	ダッシュボードで作成したブロードキャストをCLI経由で送信する	APIで作成されたブロードキャストのみ broadcasts send で送信可能 — ダッシュボードブロードキャストはダッシュボードから送信する必要があります
7	加算的動作を期待して --events を webhooks update に渡す	--events は全体のサブスクリプションリストを置き換えます — 常に完全なセットを渡してください
8	logs list にリクエスト/レスポンスボディが含まれると期待する	Listはサマリーフィールドのみreturnします — 完全な request_body と response_body には logs get <id> を使用してください

よくあるパターン

メールを送信：

resend emails send --from "you@domain.com" --to user@example.com --subject "Hello" --text "Body"

React Emailテンプレート（.tsx）を送信：

resend emails send --from "you@domain.com" --to user@example.com --subject "Welcome" --react-email ./emails/welcome.tsx

ドメインセットアップフロー：

resend domains create --name example.com --region us-east-1
# 出力からDNSレコードを構成してから：
resend domains verify <domain-id>
resend domains get <domain-id>  # ステータス確認

ブロードキャストを作成して送信：

resend broadcasts create --from "news@domain.com" --subject "Update" --segment-id <id> --html "<h1>Hi</h1>" --send

CI/CD（ログイン不要）：

RESEND_API_KEY=re_xxx resend emails send --from ... --to ... --subject ... --text ...

環境の健全性を確認：

resend doctor -q

リファレンスをロードするタイミング

• メールを送受信 → references/emails.md
• ドメインをセットアップまたは検証 → references/domains.md
• APIキーを管理 → references/api-keys.md
• ブロードキャストを作成または送信 → references/broadcasts.md
• 連絡先、セグメント、またはトピックを管理 → references/contacts.md, references/segments.md, references/topics.md
• 連絡先プロパティを定義 → references/contact-properties.md
• テンプレートを操作 → references/templates.md
• APIリクエストログを表示 → references/logs.md
• オートメーションを作成またはイベントを送信 → references/automations.md
• ウェブフックをセットアップまたはイベントをリッスン → references/webhooks.md
• 認証、プロファイル、またはヘルスチェック → references/auth.md
• マルチステップレシピ（セットアップ、CI/CD、ブロードキャストワークフロー） → references/workflows.md
• コマンドがエラーで失敗した → references/error-codes.md
• Resend SDKIntegration (Node.js, Python, Go など) → resend スキルをインストール
• AIエージェントメールインボックス → agent-email-inbox スキルをインストール