Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Revenue
Platforms and marketplaces
Money management
Developer resources
Overview
Versioning
Changelog
Upgrade your API version
Upgrade your SDK version
Essentials
SDKs
API
Testing
Stripe CLI
    Overview
    Install the CLI
    Use the CLI
    Enable autocompletion
    CLI keys
    Trigger events
    Upgrade the CLI
Sample projects
Tools
Workbench
Developers Dashboard
Stripe Shell
Stripe for Visual Studio Code
Features
Workflows
Event destinations
Stripe health alertsFile uploads
AI solutions
Agent toolkit
Model Context Protocol
Security and privacy
Security
Stripebot web crawler
Privacy
Extend Stripe
Build Stripe apps
Use apps from Stripe
Partners
Partner ecosystem
Partner certification
HomeDeveloper resourcesStripe CLI

Install the Stripe CLI

Install the Stripe CLI on macOS, Windows, or Linux.

The Stripe CLI lets you build, test, and manage your integration from the command line. You can use the Stripe CLI to:

  • Create, retrieve, update, or delete any of your Stripe resources in a sandbox.
  • 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.

To install the Stripe CLI with homebrew, run:

Command Line
brew install stripe/stripe-cli/stripe

Log in to the CLI

  1. Log in and authenticate your Stripe user account to generate a set of restricted keys. To learn more, see Stripe CLI keys and permissions.

    Command Line
    stripe login
  2. Press the Enter key 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 --interactive flag to authenticate with an existing API secret key or restricted key. This is helpful when authenticating to the CLI without a browser, such as in a CI/CD pipeline.

Command Line
stripe login --interactive

You can also use the --api-key flag to specify your API secret key inline each time you send a request.

Command Line
stripe login --api-key
sk_test_BQokikJOvBiI2HlWgH4olfQ2

Get started with a video

Watch this video to learn the different ways you can use the Stripe CLI. It covers how to configure the CLI, download sample code, and work with Stripe objects.

Loading video content...
Was this page helpful?
YesNo
  • Need help? Contact Support.
  • Join our early access program.
  • Check out our changelog.
  • Questions? Contact Sales.
  • LLM? Read llms.txt.
  • Powered by Markdoc