About

Installation

npm i -g stripe-cli

or if you love yarn

yarn global add stripe-cli

Setup

You need to provide your Stripe private key or a resticted key thought a .striperc or stripe.config.json file in the directory you'll run the CLI app with this scheme :

{
	"stripe_key": "pk_test_*******"
}

⚠️ Warning : The program will raise an exception if you try to give an live key, this tool is intented to generate FAKE DATASETS

✅ Pro tip : You can use one config file per project as it's a common practice to have separate Stripe accounts for separate projects

Usage

Start by using, you'll see all commands available and options

$ stripe --help

Available commands

Here's some of available commands and few of their options

Create customer

$ stripe create customer[s] --nationality=fr --attach-card

Create charge

$ stripe create charge --customer=cus_XXXXXXX --amount=15000 --currency=EUR --token=tok_visa

Create payout

$ stripe create payout --account=acct_XXXXXXX --amount=100000 --currency=USD

Contributing

See CONTRIBUTING.md

Licence

See LICENCE.md

Maintainers

Clément SAUVAGE

Credit

The stripe generator icon was made by my good friend Vicent a.k.a Webalys