Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Developer tools
Get started
Payments
Finance automation
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Overview
Versioning
Changelog
Upgrade your API version
Upgrade your SDK version
Developer tools
SDKs
API
Testing
Workbench
Event Destinations
Workflows
Stripe CLI
Stripe Shell
Developers Dashboard
Agent toolkit
Stripe health alertsBuild with LLMsStripe for Visual Studio CodeFile uploads
Security
Security
Extend Stripe
Stripe Apps
    Overview
    Get started
    Create an app
    How Stripe Apps work
    Sample apps
    Build an app
    Store secrets
    API authentication methods
    Authorization flows
    Server-side logic
    Listen to events
    Handle different modes
    Enable sandbox support
    App settings page
    Build a UI
    Onboarding
    Distribute your app
    Distribution options
    Upload your app
    Versions and releases
    Test your app
    Publish your app
    Promote your app
    Add deep links
    Create install links
    Assign roles in UI extensions
    Post-install actions
    App analytics
    Embedded components for Apps
    Embed third-party Stripe Apps
    Migrating to Stripe Apps
    Migrate or build an extension
    Migrate a plugin to Stripe Apps or Stripe Connect
    Reference
    App manifest
    CLI
    Extension SDK
    Permissions
    Viewports
    Design patterns
    Components
Stripe Connectors
Partners
Partner ecosystem
Partner certification
HomeDeveloper toolsStripe Apps

Stripe Apps CLI reference

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

Copy page

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.
setSet a configuration value within the app manifest.
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?
YesNo
Need help? Contact Support.
Join our early access program.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc