RevKeen CLI
Use the RevKeen command-line client for common billing, payments, and operations workflows
The RevKeen CLI is a terminal client for common operator and developer workflows. It ships from the same monorepo as the public API and SDKs and covers billing, customer, payment, webhook, automation, and reporting flows.
Source: packages/cli
The CLI uses a flag-driven command model (revkeen invoices --list), not nested subcommands. See the command reference → for every flag and prompt.
Install
npm install -g @revkeen/clipnpm add -g @revkeen/clinpx @revkeen/cli --helppnpm --filter @revkeen/cli devVerify the install:
revkeen --helpQuick start
# 1. Export an API key
export REVKEEN_API_KEY=rk_live_your_api_key
# 2. List customers
revkeen customers --list
# 3. Inspect a specific invoice
revkeen invoices --get inv_01HT...
# 4. Start an interactive create flow
revkeen checkout --createHow the CLI is shaped
revkeen <command> [mode flag] [arguments]Running revkeen with no arguments opens an interactive picker for the main command groups. Each command uses one or more mode flags:
revkeen customers --list
revkeen invoices --create
revkeen subscriptions --cancel sub_01HT...
revkeen automations --approvalsCommands at a glance
| Command | Purpose | Details |
|---|---|---|
customers | Inspect, create, and update customers | --list, --get, --create, --update |
products | Manage the product catalog | --list, --get, --create |
prices | Manage pricing | --list, --get, --create |
subscriptions | View and cancel subscriptions | --list, --get, --cancel |
invoices | Full invoice lifecycle | --list, --get, --create, --finalize, --send, --void |
payments | Payment intent workflows | --list, --get, --create, --capture, --cancel |
refunds | Issue full or partial refunds | --list, --get, --create |
orders | Full order lifecycle | --list, --get, --create, --pay, --fulfill, --cancel |
webhooks | Manage webhook endpoints | --list, --create, --delete |
entitlements | Check customer entitlements | --list, --check |
integrations | Integration health and sync | --list, --get, --sync |
automations | Automation runs and approvals | --list, --get, --run, --approvals, --approve, --reject |
analytics | Read-only reporting | --mrr, --revenue, --ar-aging, --dso, --ltv |
checkout | Create checkout sessions | --create |
terminal | Terminal / POS devices | --devices, --payments, --pay (not yet public) |
What the CLI is good at today
- Fast inspection — invoice, customer, payment, and order lookups
- Interactive creation — invoices, refunds, checkout sessions, webhook endpoints
- Operator tasks — automation approvals, integration syncs, analytics summaries
- Ad hoc workflows — when a terminal prompt is faster than the dashboard
Output format
All output is human-readable tables with color-coded status badges. The CLI does not currently support --json or --format flags. For machine-readable data, use the REST API → or an SDK →.
Status colors: paid/active/succeeded (green), open/trialing/processing (blue), paused/pending (yellow), overdue (red background), void/cancelled/failed (red), draft (gray).
Recipes
Common multi-command workflows:
# Invoice lifecycle: create → finalize → send
revkeen invoices --create
revkeen invoices --finalize inv_01HT...
revkeen invoices --send inv_01HT...
# Review and approve automation actions
revkeen automations --approvals
revkeen automations --approve apr_01HT...
# Check a customer's subscriptions and entitlements
revkeen subscriptions --list
revkeen entitlements --list cus_01HT...
# Trigger an integration sync and check analytics
revkeen integrations --sync xero
revkeen analytics --mrr