Stripeでの決済実装やWebhookのテストにおいて、Stripe CLI は必須級のツールです。

ローカル環境でWebhookイベントを受信したり、APIリクエストをトリガーしたりと、開発効率が劇的に向上します。

この記事では、各OSごとのインストール手順と、最初のセットアップ方法(ログイン)をまとめました。

スポンサーリンク

1. インストール手順

macOS (Homebrew)

Macユーザーであれば、Homebrewを使うのが最も簡単で管理しやすい方法です。

brew install stripe/stripe-cli/stripe

Windows

Scoopを使用する場合(推奨)

パッケージマネージャーのScoopを使用すると、パスの設定なども自動で行われるため便利です。

scoop bucket add stripe https://github.com/stripe/scoop-stripe-cli.git
scoop install stripe

Linux (Ubuntu / Debian)

公式のaptリポジトリを追加してインストールします。

# GPGキーの追加
curl -s https://packages.stripe.dev/api/security/keypair/stripe-cli-gpg/public | gpg --dearmor | sudo tee /usr/share/keyrings/stripe.gpg

# リストへの追加
echo "deb [signed-by=/usr/share/keyrings/stripe.gpg] https://packages.stripe.dev/stripe-cli-debian-local stable main" | sudo tee -a /etc/apt/sources.list.d/stripe.list

# アップデートとインストール
sudo apt update
sudo apt install stripe

Docker

環境を汚したくない場合や、コンテナ内で完結させたい場合はDockerイメージが利用可能です。

docker run --rm -it stripe/stripe-cli:latest version

2. ログイン(初期設定)

インストールが完了したら、StripeアカウントとCLIを紐付ける必要があります。ターミナルで以下のコマンドを実行してください。

stripe login

実行すると以下のように表示され、Enterキーを押すとブラウザが立ち上がります。

Your pairing code is: enter-pairing-code-here
This pairing code verifies your authentication with Stripe.
Press Enter to open the browser or visit https://dashboard.stripe.com/stripecli/confirm_auth?t=xxxx... (^C to quit)

ブラウザ上で認証を許可(Allow access)すると、ターミナルに戻り設定が完了します。

Note

有効期限は90日間です。期間が過ぎたら再度 stripe login を行ってください。

スポンサーリンク

3. 動作確認

正しくインストールされたか確認するために、Webhookのローカルリスナーを起動してみましょう。

stripe listen --forward-to localhost:3000/webhook

以下のように Ready! と表示されれば成功です。

> Ready! You are using Stripe API Version [xxxx-xx-xx]. Your webhook signing secret is whsec_...

これで、Stripe上で発生したイベントがローカルサーバー(この例では localhost:3000/webhook)に転送されるようになります。

4. よく使うコマンド集

開発時によく使うコマンドのチートシートです。

コマンド説明
stripe loginアカウントへのログイン
stripe listenWebhookイベントをローカルへ転送
stripe trigger payment_intent.succeeded特定のイベント(決済成功など)を強制発火
stripe logs tailAPIリクエストのログをリアルタイム表示
stripe openStripeダッシュボードをブラウザで開く

まとめ

Stripe CLIを導入することで、特にWebhook周りのデバッグ時間が大幅に短縮されます。まだ導入していない方は、ぜひ開発環境にセットアップしてみてください。


この記事が気に入ったら『目黒で働く分析担当の作業メモ』ご支援をお願いします!

※OFUSEに飛びます


おすすめの記事