RevKeen Docs

RevKeen CLI

Manage payments, subscriptions, and billing from your terminal

The RevKeen CLI brings your RevKeen workflow to the terminal. List customers, create invoices, tail webhook events, pair terminals, and hit any API endpoint without leaving your shell.

Installation

macOS (Homebrew)

brew install revkeen/tap/revkeen

Linux (Debian/Ubuntu)

curl -fsSL https://releases.revkeen.com/cli/install.sh | bash

Or download the .deb package from the latest release:

sudo dpkg -i revkeen_linux_amd64.deb

Linux (RPM)

sudo rpm -i revkeen_linux_amd64.rpm

Windows

Download the .zip archive from the latest release, extract it, and add the directory to your PATH.

Go install

If you have Go installed:

go install github.com/revkeen/cli@latest

Verify installation

revkeen --version

Quick start

1. Authenticate

revkeen config set api-key rk_sandbox_your_api_key

Or set the environment variable:

export REVKEEN_API_KEY=rk_sandbox_your_api_key

2. List customers

revkeen customers list

3. Get a specific customer

revkeen customers get --id cus_xxxxxxxx

4. Create an invoice

revkeen invoices create --customer-id cus_xxxxxxxx --amount 5000

5. Try a different output format

revkeen customers list --output json
revkeen customers list --output csv

How it works

The CLI combines two command sources:

  • Resource commands (customers, invoices, products, subscriptions, etc.) are auto-generated from the RevKeen OpenAPI specification using climate. When new API endpoints ship, the CLI picks them up automatically.
  • Custom commands (auth, webhooks, terminal, config, api) are hand-written Cobra commands for workflows that go beyond simple CRUD.

Output formats

Every command supports four output formats via the --output flag:

FormatFlagDescription
Table--output tableHuman-readable aligned columns (default)
JSON--output jsonPretty-printed JSON
YAML--output yamlKey-value YAML
CSV--output csvComma-separated values for spreadsheet import

Set a default format so you don't have to pass the flag every time:

revkeen config set output json

Configuration

The CLI stores settings in ~/.revkeen/config.toml:

[auth]
mode = "api_key"
api_key = "rk_live_your_api_key"

[settings]
base_url = "https://api.revkeen.com"
default_output = "table"

Manage settings with the config command:

revkeen config set api-key rk_live_your_api_key
revkeen config set environment staging
revkeen config list

The REVKEEN_API_KEY environment variable always takes priority over the config file.

Environments

Switch between production and staging:

# Point to staging
revkeen config set environment staging

# Point to production
revkeen config set environment production

# Or set a custom base URL
revkeen config set base-url https://staging-api.revkeen.com

Updating

Homebrew

brew upgrade revkeen

Direct download

Download the latest release from GitHub Releases and replace the existing binary.

Next steps

On this page