Get started with the Stripe CLI
Build, test, and manage your Stripe integration directly from the command line.
The Stripe CLI is a developer tool to help you build, test, and manage your integration with Stripe directly from the command line. It’s simple to install, works on macOS, Windows, and Linux, and offers a range of functionality to enhance your developer experience with Stripe. You can use the Stripe CLI to:
- Create, retrieve, update, or delete any of your Stripe resources in test mode (for example, create a product)
- Stream real-time API requests and events happening in your account
- Trigger events to test your webhooks integration
Install the Stripe CLI
- From the command-line, use an install script or download and extract a versioned archive file for your operating system to install the CLI.
Log in to the CLI
- Login and authenticate your Stripe user Account to generate a set of restricted keys. To learn more, see Stripe CLI keys and permissions.
Terminal
stripe login
- Press the
Enterkey on your keyboard to complete the authentication process in your browser.
Output
Your pairing code is: enjoy-enough-outwit-win This pairing code verifies your authentication with Stripe. Press Enter to open the browser or visit https://dashboard.stripe.com/stripecli/confirm_auth?t=THQdJfL3x12udFkNorJL8OF1iFlN8Az1 (^C to quit)
- Optionally, if you don’t want to use a browser, use the
--interactiveflag to authenticate with an existing API secret key or restricted key. This can be helpful when authenticating to the CLI without a browser, such as in a CI/CD pipeline.
Terminal
stripe login --interactive
- Optionally, use the
--api-keyflag to specify your API secret key inline each time you send a request.
Terminal
stripe login --api-keysk_test_4eC39HqLyjWDarjtT1zdp7dc
Get started with a video
Watch this video to learn different ways to use the Stripe CLI. It covers how to configure the CLI for a CI/CD pipeline, specify a secret key as an environment variable, and setup a local server with a Stripe sample.