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

エージェント プロトコル

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

エージェント用ルール:

• 必須フラグをすべて指定してください。stdin が TTY でない場合、CLI はプロンプトを表示しません。
• スピナーとステータスメッセージを抑制するには --quiet(または -q)を渡してください。
• 終了コード 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	JSON 出力を強制します(非 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
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 / commands	ユーティリティコマンド

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

ドライラン: emails send と broadcasts create のみが --dry-run に対応しています(API を呼び出さずにペイロード検証を実行)。これらは stdout に { "dryRun": true, "request": { ... } } を出力します。emails batch、broadcasts send、その他のコマンドにはまだ --dry-run はありません。

よくある誤り

#	誤り	対策
1	delete コマンドで --yes を忘れる	すべての delete/rm サブコマンドは非インタラクティブモードで --yes が必須です。そうでないと CLI はエラーで終了します
2	ウェブフック signing_secret を保存しない	webhooks create は秘密を一度だけ表示します。後で取得することはできません。コマンド出力から直ちにキャプチャしてください
3	CI で --quiet を省略する	-q なしでは、スピナーとステータステキストは依然として stderr に出力されます(stdout ではなく)。-q を使用して stdout に JSON を出力し、stderr のスピナーノイズを削除してください
4	--scheduled-at をバッチに使用する	バッチ送信は scheduled_at をサポートしていません。代わりに単一の emails send を使用してください
5	domains list が DNS レコードを含むと期待する	リストは概要のみを返します。完全な records[] 配列を取得するには domains get <id> を使用してください
6	ダッシュボードで作成したブロードキャストを CLI で送信する	API で作成されたブロードキャストのみが broadcasts send で送信できます。ダッシュボードブロードキャストはダッシュボードから送信する必要があります
7	加算的な動作を期待して --events を webhooks update に渡す	--events はサブスクリプションリスト全体を置き換えます。常に完全なセットを渡してください
8	logs list がリクエスト/レスポンス本文を含むと期待する	リストは概要フィールドのみを返します。完全な 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/webhooks.md
• 認証、プロフィール、ヘルスチェック → references/auth.md
• マルチステップレシピ(セットアップ、CI/CD、ブロードキャストワークフロー) → references/workflows.md
• コマンドがエラーで失敗した → references/error-codes.md
• Resend SDK インテグレーション(Node.js、Python、Go など) → resend スキルをインストール
• AI エージェントメール受信トレイ → agent-email-inbox スキルをインストール