RevKeen CLI
Install and use the RevKeen command-line client for billing, payments, and operations workflows
The RevKeen CLI is a single, self-contained binary for operator and developer workflows — customers, invoices, subscriptions, payments, refunds, webhooks, and reporting, all from your terminal. Its commands are generated from the RevKeen API contract, so they stay in sync with the API.
The CLI uses a subcommand model (revkeen invoices list), not flags like
--list. See the command reference →.
Install
brew install revkeen/tap/revkeennpm install -g @revkeen/cli-binarycurl -fsSL https://cli.revkeen.com/install.sh | shAll three install the same revkeen binary — pick the one that fits your
environment. Verify the install:
revkeen --version
revkeen --helpAuthentication
Authenticate once with either an interactive login or an API key:
# Interactive OAuth device login (recommended for humans)
revkeen auth login
# Or store an API key (recommended for scripts/CI)
revkeen config set api-key rk_live_your_api_key
# Or via environment variable
export REVKEEN_API_KEY=rk_live_your_api_keyConfiguration is stored in ~/.revkeen/config.toml. See
CLI authentication → for the full precedence and
staging setup.
Quick start
revkeen customers list
revkeen customers get cus_01HT3N...
revkeen invoices list --json
revkeen analytics revenue-mrr-summaryHow the CLI is shaped
revkeen <resource> <action> [arguments] [flags]Resource commands map to the RevKeen API. Common actions are list, create,
get, and update, plus resource-specific actions (e.g.
invoices finalize, subscriptions cancel). Run revkeen <resource> --help to
see the exact actions and flags for any resource.
Commands at a glance
Resource commands (generated from the API):
Generated from the API contract — 24 resource groups, 117 commands. Run revkeen <resource> --help for the exact actions and flags for your installed version.
| Group | Actions |
|---|---|
analytics | revenue-mrr-summary, revenue-time-series |
cart-api-keys | status, ensure, rotate |
cart-sessions | create, get, add-line-item, update-line-item, remove-line-item, toggle-add-on, apply-discount-code, set-contact, convert |
checkout-sessions | create, get, expire |
credit-notes | list, create, get, void, list-lines, preview |
customer-meters | list, get |
customer-portal | sessions-create, customer-get, subscriptions-list, subscriptions-get, subscriptions-cancel, invoices-list, invoices-get, mandates-list, mandates-reauthorize, mandates-cancel, mandates-reauthorize-send-otp, mandates-reauthorize-verify-otp |
customers | create, list, get, update, payment-rails-get, preferred-rails-get, payment-methods-list |
dd | mandate-requests-get, validate, preview |
entitlements | list, check |
events | list, get, resend |
integrations | accounting-invoice-payment-requests-create, accounting-invoice-payment-requests-get |
invoices | list, create, get, update, margin-estimate, finalize, void, send |
mandates | create, list, get, cancel, suspend, reinstate, schedule-collection |
payment-intents | create, list, get, confirm, capture, cancel |
payment-links | create, list, get, expire, update, deactivate, activate, archive |
prices | list, create, get, update, archive |
products | list, create, get, update |
refunds | list, create, get |
storefront | products-list, products-get, origins-list, origins-create, origins-delete, status-get |
subscriptions | create, list, get, update, cancel |
transactions | list, get |
webhook-deliveries | list, get, retry |
webhook-endpoints | list, create, get, update, delete, rotate-secret |
Operator commands (hand-written):
| Command | Purpose |
|---|---|
auth | login / logout / status |
config | set / list |
api | Raw authenticated request to any endpoint |
terminal | PAX terminal pair / status / pay |
webhooks | listen (local forwarding) / list |
Output formats
Output defaults to a human-readable table. Use the global flags for other forms:
| Flag | Output |
|---|---|
| (default) | Table |
--json | Pretty-printed JSON |
--output yaml / --output csv | YAML / CSV |
--agent | Compact JSON, no color, errors as JSON on stderr (for tools/LLMs) |