Skip to content
Sign in
An image of the Stripe logo
Create account
Sign in
Home
Payments
Finance automation
Banking as a service
Developer tools
No-code
All products
Home
Payments
Finance automation
Home
Payments
Finance automation
Banking as a service
Developer tools
Overview
Building your integration
Developer tools
SDKs
API
Security
Sample projects
Videos
Stripe Apps
    Overview
    Get started
    Create an app
    How Stripe Apps work
    Sample apps
    Development
    Store secrets
    Authorization flows
    Server-side logic
    App settings page
    Build a UI
    Onboarding
    UI design
    Design your app
    Style your app
    Design patterns
    Components
    Share and distribute
    Distribution options
    Upload your app
    Versions and releases
    Test your app
    Publish your app
    Promote your app
    Add deep links
    Using roles in UI Extensions
    Post-install actions
    App analytics
    Reference
    App manifest
    CLI
    Extension SDK
    Permissions
    Viewports
    Extensions
    Migrate to Stripe Apps
    Building extensions
Stripe Connectors
Partners
HomeDeveloper tools

Stripe Apps CLI reference

Install the Stripe Apps command line interface and use it to manage your app.

The Stripe Apps CLI helps you create, develop, configure, and upload your Stripe app using the terminal.

Before you begin

  1. Log in to the Stripe Dashboard using your existing Stripe account, or by creating a new one.
  2. Install the Stripe CLI.
  3. Log in to the CLI using the same account you logged into the Stripe Dashboard with.
    Command Line
    stripe login
  4. Verify that you’re using CLI version 1.8.11 or newer.
    Command Line
    stripe version # expected output: stripe version 1.8.11

Install the CLI plugin

To install the Stripe Apps CLI plugin, run:

Command Line
stripe plugin install apps

Upgrade the CLI plugin

To get the latest version of the Stripe Apps CLI plugin, run:

Command Line
stripe plugin upgrade apps

Command overview

CommandDescription
createCreate a new Stripe app.
startStart a development server for viewing your app in the Stripe Dashboard. Use the --manifest flag to load an extended manifest file.
addAdd a building block for developing your app.
removeRemove a building block from your stripe-app.json file.
grantGrant configuration access to your app.
revokeRevoke configuration access to your app.
uploadUpload your app to be submitted for review.
versionPrint the version of Stripe Apps CLI plugin.

See also

  • App manifest reference
  • Permissions reference
  • How UI extensions work
  • Upload and install your Stripe App
Was this page helpful?
Need help? Contact Support.
Watch our developer tutorials.
Check out our product changelog.
Questions? Contact Sales.
Powered by Markdoc
You can unsubscribe at any time. Read our privacy policy.
On this page
Before you begin
Install the CLI plugin
Upgrade the CLI plugin
Command overview
See also
Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Login to your Stripe account and press Control + Backtick on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g. )
The Stripe Shell is best experienced on desktop.
$