RevKeen CLI

Install the RevKeen CLI, sign in, and make your first staging request, forward a test webhook, or check a Cart integration.

Use RevKeen from your terminal to look up resources, script API requests, forward webhooks to a local server, and check a Cart integration. For application code, use an SDK; for an AI assistant, use MCP.

The current release is v0.3.0 (30 September 2026). Browser and device sign-in, listen, trigger, webhooks, cart, doctor, terminal and dashboard first shipped in v0.2 (27 September 2026). The npm package, Homebrew formula, shell installer and GitHub release all publish the same version.

Install

npm install -g @revkeen/cli-binary

Download release assets and checksums. The shell installer and Homebrew support macOS and Linux; the release also publishes .deb and .rpm packages. The npm wrapper requires Node.js 16 or newer; use a maintained Node.js release.

Check the installed version and the commands it provides:

revkeen --version
revkeen --help

To pin a version, for example in CI, install @revkeen/cli-binary@<version> or download that release's assets.

Quickstart

Choose staging

revkeen config set environment staging

This sets the API origin to https://staging-api.revkeen.com. Use staging, with a staging merchant, until your integration is ready.

revkeen login
revkeen auth status

revkeen login opens your browser to sign in and approve access. On a remote or headless machine, use revkeen login --device. To use a secret API key instead, run revkeen login --api-key and paste an rk_sandbox_* key at the prompt. See authentication for what each method can access.

List customers

revkeen customers list
revkeen api GET '/v2/customers?limit=10' --agent

An empty list is a valid result for a merchant with no customers. A 401 means you are not signed in or the credential is invalid; a 403 means the credential lacks the access the command needs.

Forward a test webhook

listen and trigger need webhook access, which browser sign-in does not grant. Sign in with a staging secret API key first (revkeen login --api-key, or set REVKEEN_API_KEY). Start your receiver on port 4242, then:

revkeen listen --forward-to http://127.0.0.1:4242/webhooks

In a second terminal:

revkeen trigger invoice.paid

trigger sends a test fixture to your running listen session only. It creates no invoice and moves no money. See test webhooks locally.

Update and troubleshoot

Check release notes before upgrading.

npm install -g @revkeen/cli-binary@latest
# Homebrew installations:
brew upgrade revkeen

If revkeen is not found, check PATH and open a new terminal. If a command is unknown, compare revkeen --version with the release notes: an older binary does not have newer commands. Run revkeen <command> --help for the exact flags of your installed version.

Resource command catalogue

Each API resource has a command group. The table below is generated from the API contract that the CLI embeds; run revkeen <resource> --help for the actions and flags in your installed version.

Generated from the API contract — 29 resource groups, 135 commands. Run revkeen <resource> --help for the exact actions and flags for your installed version.

Group	Actions
`billing`	`overview-get`
`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`	`customer-state-get`, `create`, `list`, `get`, `update`, `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`
`invoice-line-items`	`list-usage-events`
`invoices`	`invoice-usage-explain`, `list`, `create`, `get`, `update`, `get-pdf`, `finalize`, `void`, `send`, `pay`
`mandates`	`list`, `get`, `cancel`, `suspend`, `reinstate`, `schedule-collection`
`meters`	`list`, `create`, `quantities`, `get`, `update`
`payment-intents`	`create`, `list`, `get`, `confirm`, `capture`, `cancel`
`payment-links`	`create`, `list`, `get`, `expire`, `update`, `deactivate`, `activate`, `archive`
`payment-methods`	`detach`, `set-default`
`prices`	`list`, `create`, `get`, `update`, `archive`
`product-collections`	`list`, `create`, `get`, `update`, `delete`
`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`, `change-plan`, `preview-change-plan`, `pause`, `resume`, `cancel`
`transactions`	`list`, `get`
`usage`	`balance-get`
`usage-events`	`ingest`, `list`, `get`
`webhook-deliveries`	`list`, `get`, `retry`
`webhook-endpoints`	`list`, `create`, `get`, `update`, `delete`, `rotate-secret`, `redeliver`

RevKeen CLI

Install

Quickstart

Choose staging

List customers

Forward a test webhook

Update and troubleshoot

Resource command catalogue

Next steps

Authentication and CI

Command reference

Test webhooks locally

On this page