Command Reference

This page mirrors the current top-level command surface in packages/cli/src/index.ts.

Command pattern

The current CLI uses a top-level command plus one or more mode flags:

revkeen <command> [mode flag]

Examples:

revkeen customers --list
revkeen invoices --get inv_01HT...
revkeen refunds --create
revkeen automations --approvals

Running revkeen with no arguments opens the interactive command picker.

Command matrix

Command	Modes	Notes
`customers`	`--list`, `--get <id>`, `--create`, `--update <id>`	Customer inspection and interactive create/update
`products`	`--list`, `--get <id>`, `--create`	Product catalog workflows
`prices`	`--list`, `--get <id>`, `--create`	Pricing setup workflows
`subscriptions`	`--list`, `--get <id>`, `--cancel <id>`	Subscription lookups and cancellation
`invoices`	`--list`, `--get <id>`, `--create`, `--finalize <id>`, `--send <id>`, `--void <id>`	Invoice lifecycle actions
`payments`	`--list`, `--get <id>`, `--create`, `--capture <id>`, `--cancel <id>`	Payment intent workflows
`refunds`	`--list`, `--get <id>`, `--create`	Refund workflows
`orders`	`--list`, `--get <id>`, `--create`, `--pay <id>`, `--fulfill <id>`, `--cancel <id>`	Order lifecycle actions
`webhooks`	`--list`, `--create`, `--delete <id>`	Webhook endpoint management
`entitlements`	`--list <customerId>`, `--check`	Customer entitlement inspection
`integrations`	`--list`, `--get <provider>`, `--sync <provider>`	Integration health and sync control
`automations`	`--list`, `--get <id>`, `--run <id>`, `--runs <automationId>`, `--run-detail <runId>`, `--approvals`, `--approve <approvalId>`, `--reject <approvalId>`, `--reason <reason>`	Automation execution and approval flows
`analytics`	`--mrr`, `--revenue`, `--ar-aging`, `--dso`, `--ltv`	Read-only reporting summaries
`terminal`	`--devices`, `--payments`, `--pay`	Public implementation currently returns a not-yet-available warning
`checkout`	`--create`	Interactive checkout session creation

Common examples

# List customers
revkeen customers --list

# Retrieve one customer
revkeen customers --get cus_01HT...

# Start the interactive invoice creation flow
revkeen invoices --create

# Finalize and then send an invoice
revkeen invoices --finalize inv_01HT...
revkeen invoices --send inv_01HT...

# Review pending automation approvals
revkeen automations --approvals

# Trigger an integration sync
revkeen integrations --sync xero

Notes on current behavior

Many --create flows are interactive and prompt for missing fields.
The CLI does not currently expose a generic raw api command.
The CLI does not currently expose login, logout, profile, listen, or trigger commands.
Authentication is API-key based through REVKEEN_API_KEY or an interactive prompt. See CLI authentication.

CLI overview

Installation, command shape, and common examples.

CLI authentication

Environment variables and base URL overrides.

API Reference

Canonical REST contract behind the broader platform.