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
- Log in to the Stripe Dashboard using your existing Stripe account, or by creating a new one.
- Install the Stripe CLI .
- Log in to the CLI using the same account you logged into the Stripe Dashboard with. Command Line
stripe login - 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
| Command | Description |
|---|---|
create | Create a new Stripe app. |
start | Start a development server for viewing your app in the Stripe Dashboard. Use the --manifest flag to load an extended manifest file. Enable local network access before viewing your app. |
add | Add a building block for developing your app. |
remove | Remove a building block from your stripe-app.json file. |
grant | Grant configuration access to your app. |
revoke | Revoke configuration access to your app. |
set | Set a configuration value within the app manifest. |
upload | Upload your app to be submitted for review. |
version | Print the version of Stripe Apps CLI plugin. |