Stripe CLI
Build, test, and manage your Stripe integration right from the terminal.
The Stripe CLI is a developer tool to help you help build, test, and manage your integration with Stripe directly from your terminal. The Stripe CLI is easy to install, works on macOS, Windows, and Linux, and offers you a range of functionality to make your developer experience with Stripe better.
With the Stripe CLI, you can:
- Securely test webhooks without relying on third-party tunneling software
- Trigger webhook events to easily test your integration
- Receive API request logs locally
- Create, retrieve, update, and delete API objects
Follow the steps below to get started with the Stripe CLI.
Step 1: Install the Stripe CLI
To install the Stripe CLI with homebrew, run:
brew install stripe/stripe-cli/stripe
To install the Stripe CLI on macOS without homebrew:
- Download the latest
mac-os
tar.gz file from https://github.com/stripe/stripe-cli/releases/latest - Unzip the file:
tar -xvf stripe_X.X.X_mac-os_x86_64.tar.gz
Optionally, install the binary in a location where you can execute it globally (e.g., /usr/local/bin
).
To install the Stripe CLI on Debian and Ubuntu-based distributions:
- Add Bintray’s GPG key to the apt sources keyring:
sudo apt-key adv --keyserver hkp://pool.sks-keyservers.net:80 --recv-keys 379CE192D401AB61
- Add stripe-cli’s apt repository to the apt sources list:
echo "deb https://dl.bintray.com/stripe/stripe-cli-deb stable main" | sudo tee -a /etc/apt/sources.list
- Update the package list:
sudo apt-get update
- Install the CLI:
sudo apt-get install stripe
To install the Stripe CLI on RedHat and CentOS-based distributions:
- Add stripe-cli’s yum repository to the yum sources list:
wget https://bintray.com/stripe/stripe-cli-rpm/rpm -O bintray-stripe-stripe-cli-rpm.repo && sudo mv bintray-stripe-stripe-cli-rpm.repo /etc/yum.repos.d/
- Install the CLI:
sudo yum install stripe
To install the Stripe CLI on Linux without a package manager:
- Download the latest
linux
tar.gz file from https://github.com/stripe/stripe-cli/releases/latest - Unzip the file:
tar -xvf stripe_X.X.X_linux_x86_64.tar.gz
- Run the executable:
./stripe
To install the Stripe CLI with Scoop, run:
scoop bucket add stripe https://github.com/stripe/scoop-stripe-cli.git
scoop install stripe
To install the Stripe CLI on Windows without Scoop, run:
- Download the latest
windows
tar.gz file from https://github.com/stripe/stripe-cli/releases/latest - Unzip the
stripe_X.X.X_windows_x86_64.zip
file - Run the unzipped
.exe
file
The Stripe CLI is also available as a Docker image. To install the latest version, run:
docker run --rm -it stripe/stripe-cli:latest
Step 2: Login with your Stripe account
After installing the Stripe CLI, you must pair it with your Stripe account. To do so, run stripe login
in the terminal. You’ll be prompted to launch your browser and login to the Stripe Dashboard to grant the Stripe CLI access to your account.
stripe login
Your pairing code is: humour-nifty-finer-magic Press Enter to open up the browser (^C to quit)
Pairing generates a pair of secret API keys—one test mode, one live mode—that are valid for 90 days. You can also manually delete the key under API Keys in the Dashboard (e.g., when you’re done using the Stripe CLI). If you’re in an environment that doesn’t have a browser, a URL will be printed to use outside of that environment.
Step 3: Run your first command
You are now ready to use the Stripe CLI, and to get started you can run your first command to create a customer by running:
stripe customers create
This command creates a new customer on Stripe and returns the raw Customer object as JSON.
Next steps
To see what else you can do with the Stripe CLI, use the following guides or run the stripe --help
command to see what’s possible.