Skip to main content
The Creem CLI gives you full control of your store without leaving the terminal. Browse products, customers, subscriptions, and transactions through an interactive interface, or run quick commands for day-to-day operations.

​
Installation

brew tap armitage-labs/creem
brew install creem
Once installed, run creem to see the full command reference:

​
Login

creem login --api-key creem_test_YOUR_KEY_HERE
The CLI auto-detects test vs live mode from your key prefix. You can verify your session at any time: 
$ creem whoami

✓ Logged in to Creem

Environment  test
API Key      creem_te...5mBJ
API URL      https://test-api.creem.io
Start in test mode. Use a creem_test_ key while getting familiar with the CLI. Switch to live only when you’re ready for real transactions.

​
Interactive Mode

This is where the CLI really shines. Run any resource command without a subcommand to launch an interactive browser: 
creem products
creem customers
creem subscriptions
creem transactions
You get a full TUI (terminal user interface) where you can browse, search, and drill into records without writing any commands.

​
Browsing Transactions

Press Enter on any row to drill into the full detail view:

​
Managing Subscriptions

Navigate into any subscription to see its full details and take actions directly from the status bar:
Navigation keys:
  • j/k or arrow keys to move through the list
  • Enter to view details
  • / to search
  • : to open the command bar (cancel, pause, resume)
  • q to go back or exit

​
Quick Commands

For when you need something specific without browsing: 
# Products
creem products list
creem products get prod_XXXXX
creem products create --name "Pro Plan" --price 1999 --currency USD --billing-type recurring --billing-period every-month

# Customers
creem customers list
creem customers get cust_XXXXX
creem customers billing cust_XXXXX   # generates a billing portal link

# Subscriptions
creem subscriptions list --status active
creem subscriptions cancel sub_XXXXX --mode scheduled
creem subscriptions pause sub_XXXXX
creem subscriptions resume sub_XXXXX

# Transactions
creem transactions list --limit 50
creem transactions get txn_XXXXX

# Checkouts
creem checkouts create --product prod_XXXXX --success-url https://app.com/welcome
Use --mode scheduled when cancelling subscriptions. This lets the customer keep access until their billing period ends instead of cutting them off immediately.

​
Configuration

creem config show                        # view all settings
creem config set environment live        # switch to live mode
creem config set output_format json      # default to JSON output
Every command also supports --json for one-off JSON output, useful for piping into other tools: 
creem products list --json | jq '.[].name'

​
Going Live

Before accepting real payments:
  1. Complete account verification in the Dashboard under Balances → Payout Account
  2. Switch to your live API key:
creem login --api-key creem_LIVE_KEY_HERE

​
Next Steps

Store Monitoring

Set up automated monitoring so your AI agent notifies you about sales and issues

Webhooks

Handle real-time payment events in your application