Command Reference

This reference covers CLI v0.3.0. Check your installed version and its commands:

revkeen --version
revkeen --help
revkeen <command> --help

Global flags

--agent, --json and --table are mutually exclusive. A failed request exits with a non-zero status: check the exit code before consuming stdout.

login and auth

revkeen login            # browser sign-in (default)
revkeen login --device   # device code, for headless machines
revkeen login --api-key  # paste a secret API key
revkeen auth status
revkeen auth logout

Use only one of --device, --api-key and --with-token. revkeen auth login is the same command. See authentication for what each method can access.

config

revkeen config set environment staging
revkeen config set output json
revkeen config list

api

The raw command sends any HTTP method to any versioned API path. Include /v2 in the path.

revkeen api GET '/v2/customers?limit=10'
revkeen api GET /v2/invoices --agent
revkeen api GET "/v2/customers/$REVKEEN_CUSTOMER_ID" --agent

The command prints the response JSON. A 400 or higher response exits non-zero. Write requests can change merchant data or start financial operations: build them from the API reference and start in staging. api has no flag for custom headers, so use an SDK or HTTP client when you need your own idempotency key.

listen

Forwards webhook events for your merchant to a local URL.

revkeen listen --forward-to http://127.0.0.1:4242/webhooks
revkeen listen --forward-to http://127.0.0.1:4242/webhooks --events invoice.paid,payment.succeeded

On connect, listen prints a signing secret for the session. Each forwarded request carries an X-Revkeen-Signature header signed with that secret, in the same format as a delivered webhook, so your receiver can verify it. The secret is new for every session. Stop with Ctrl+C.

listen needs webhook read access: sign in with a secret API key. It forwards events emitted for your merchant while the session is open and fixtures sent with trigger. It does not replay past events. Also available as revkeen webhooks listen.

trigger

Sends a test fixture to the running listen sessions for your merchant.

revkeen trigger payment.succeeded
revkeen trigger invoice.paid

Typed fixtures exist for payment.succeeded, payment.failed, invoice.paid, invoice.created, invoice.payment_failed, customer.created, subscription.created, subscription.canceled and checkout.session.completed. Other event types receive a generic payload. Fixtures carry livemode: false and triggered: true. They go to CLI listeners only: trigger creates no records, sends nothing to your registered endpoints, and moves no money. It needs webhook write access.

webhooks

revkeen webhooks listen --forward-to http://127.0.0.1:4242/webhooks
revkeen webhook-endpoints list

revkeen webhooks listen is the same as listen. revkeen webhooks list is not implemented yet and exits with an error: use revkeen webhook-endpoints list to list your registered endpoints.

cart

Sets up and inspects RevKeen Cart for a storefront. Start with read-only checks:

revkeen cart status
revkeen cart origins list

cart status reports activation, keys, allowed origins, webhooks, and products.

The following commands change merchant configuration. An authorised administrator should run them for the intended merchant, in staging first:

revkeen cart keys issue
revkeen cart origins add https://storefront-staging.example.com
revkeen cart origins remove https://storefront-staging.example.com
revkeen cart webhooks setup --url https://storefront-staging.example.com/webhooks/revkeen

cart keys issue runs as you: sign in with revkeen login first. Your role in the merchant decides whether you can issue keys (owner, admin or developer). Issuing keys with an API key is being retired, and the command warns when only an API key is configured.

New key material is printed once, on first issue. Store it in your secret store immediately, not in CI logs. Re-running reports key status without showing secrets. The publishable key belongs on approved browser origins; the secret key stays on your server.

doctor

A read-only health check for a Cart integration.

revkeen doctor
revkeen doctor --project-path ./storefront --json

doctor combines the remote Cart readiness with a local check of the project's environment variables. It reports whether each variable is present, never its value. The report lists each check as pass, warn, or fail with a suggested next action.

dashboard

revkeen dashboard

Opens an interactive terminal dashboard for customers, invoices, subscriptions, Cart, and doctor. Running revkeen with no arguments in a terminal opens it too. Aliases: ui, tui. The dashboard uses your current sign-in and grants no extra permissions.

terminal

revkeen terminal pair, terminal status and terminal pay are reserved for POS terminal management and are not implemented yet: each exits with an error. Pair and manage terminals from the dashboard.

Resource commands

Each API resource has a command group with actions such as list, get and create:

revkeen customers --help
revkeen customers list
revkeen invoices get inv_xxxxxxxx --json

The table below is generated from the API contract that the CLI embeds. Use the actions and arguments reported by your installed binary.

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

Removed commands

revkeen init and the doctor --cms flag were removed in v0.3.0. Both now return an unknown command or flag error. Use cart and doctor to set up and check a Cart integration.

Owner: david · Reviewed 30 Sep 2026 · Next review 30 Oct 2026