Enable autocompletion for the Stripe CLI

Enable autocompletion so that the Stripe CLI automatically completes your commands.

Use the stripe completion command to enable autocompletion so that the Stripe CLI automatically completes your commands. After you enable autocomplete, you can type a command and press the tab key on your keyboard to view available commands and flags.

Setup with ZSH on macOS and Linux

Open a new ZSH shell and run the following commands:

Command Line

stripe completion
mkdir -p ~/.stripe
mv stripe-completion.zsh ~/.stripe

Add the following lines to your .zshrc file:

Command Line

# The next lines enables shell command completion for Stripe
fpath=(~/.stripe $fpath)
autoload -Uz compinit && compinit -i

Setup with Bash on macOS and Linux

Follow the instructions in bash-completion to set up bash completions.

Open a new Bash shell and run the following commands:

Command Line

stripe completion
mkdir -p ~/.stripe
mv stripe-completion.bash ~/.stripe

Add the following lines to your .bashrc file:

Command Line

# The next line enables shell command completion for Stripe
source ~/.stripe/stripe-completion.bash

Windows

Windows autocompletion is currently not supported.

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. )