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 currently ships from the same monorepo as the public API and SDKs and covers the highest-traffic billing, customer, payment, webhook, automation, and reporting flows.

Source: packages/cli

The CLI in this repo is a Node.js package with a revkeen executable. Its command model is flag-driven, not nested subcommands.

Install

npm install -g @revkeen/cli

pnpm add -g @revkeen/cli

npx @revkeen/cli --help

pnpm --filter @revkeen/cli dev

Verify the install:

revkeen --help

Quick 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 --create

How the CLI is shaped

The current CLI uses top-level commands with mode flags:

revkeen <command> [mode flag]

Examples:

revkeen customers --list
revkeen invoices --create
revkeen subscriptions --cancel sub_01HT...
revkeen automations --approvals

If you run revkeen with no arguments, it opens an interactive picker for the main command groups.

Top-level commands

Command	Current modes
`customers`	`--list`, `--get <id>`, `--create`, `--update <id>`
`products`	`--list`, `--get <id>`, `--create`
`prices`	`--list`, `--get <id>`, `--create`
`subscriptions`	`--list`, `--get <id>`, `--cancel <id>`
`invoices`	`--list`, `--get <id>`, `--create`, `--finalize <id>`, `--send <id>`, `--void <id>`
`payments`	`--list`, `--get <id>`, `--create`, `--capture <id>`, `--cancel <id>`
`refunds`	`--list`, `--get <id>`, `--create`
`orders`	`--list`, `--get <id>`, `--create`, `--pay <id>`, `--fulfill <id>`, `--cancel <id>`
`webhooks`	`--list`, `--create`, `--delete <id>`
`entitlements`	`--list <customerId>`, `--check`
`integrations`	`--list`, `--get <provider>`, `--sync <provider>`
`automations`	`--list`, `--get <id>`, `--run <id>`, `--runs <automationId>`, `--run-detail <runId>`, `--approvals`, `--approve <approvalId>`, `--reject <approvalId>`
`analytics`	`--mrr`, `--revenue`, `--ar-aging`, `--dso`, `--ltv`
`checkout`	`--create`
`terminal`	`--devices`, `--payments`, `--pay`

What the CLI is good at today

Fast inspection workflows like invoice, customer, payment, and order lookups
Interactive create flows for invoices, refunds, checkout sessions, and webhook endpoints
Lightweight operator tasks around automations, integrations, and analytics summaries
Ad hoc internal workflows where a terminal prompt is faster than dashboard navigation

Important behavior

Authentication is currently API-key based. See CLI authentication.
If REVKEEN_API_KEY is not set, the CLI prompts for a key interactively.
The default API base URL is https://api.revkeen.com.
REVKEEN_API_URL can override the base URL for staging or internal environments.
Running terminal currently shows a not-yet-available warning in the public CLI implementation.

Examples

# Customers
revkeen customers --list
revkeen customers --get cus_01HT...

# Invoices
revkeen invoices --create
revkeen invoices --send inv_01HT...

# Payments
revkeen payments --get pi_01HT...
revkeen payments --capture pi_01HT...

# Webhooks
revkeen webhooks --list
revkeen webhooks --create

# Analytics
revkeen analytics --mrr
revkeen analytics --revenue

Authentication

API keys, interactive prompt flow, and base URL overrides.

Command reference

The current top-level command and mode matrix.

API Reference

Canonical REST contract backing the SDKs and related CLI workflows.

SDKs

Use the official clients for application code.

RevKeen CLI

Authentication

Command reference

API Reference

SDKs

On this page