Command Reference

This page lists every command available in the RevKeen CLI, grouped by category.

Global flags

These flags work with any command:

Flag	Short	Default	Description
`--output`	`-o`	`table`	Output format: `table`, `json`, `yaml`, `csv`
`--no-color`		`false`	Disable color output
`--api-key`			Override API key for this command
`--help`	`-h`		Show help for any command
`--version`	`-v`		Print CLI version

Resource commands

Resource commands are auto-generated from the RevKeen OpenAPI specification. They cover all API endpoints and follow a consistent pattern:

revkeen <resource> <action> [flags]

Customers

# List all customers
revkeen customers list

# Get a specific customer
revkeen customers get --id cus_xxxxxxxx

# Create a customer
revkeen customers create --name "Jane Doe" --email "jane@example.com"

# Update a customer
revkeen customers update --id cus_xxxxxxxx --name "Jane Smith"

# Delete a customer
revkeen customers delete --id cus_xxxxxxxx

Invoices

# List invoices
revkeen invoices list

# Get a specific invoice
revkeen invoices get --id inv_xxxxxxxx

# Create an invoice
revkeen invoices create --customer-id cus_xxxxxxxx --amount 5000

# Finalize an invoice
revkeen invoices finalize --id inv_xxxxxxxx

# Void an invoice
revkeen invoices void --id inv_xxxxxxxx

Products

# List products
revkeen products list

# Get a product
revkeen products get --id prod_xxxxxxxx

# Create a product
revkeen products create --name "Pro Plan" --billing-type recurring

Subscriptions

# List subscriptions
revkeen subscriptions list

# Get a subscription
revkeen subscriptions get --id sub_xxxxxxxx

# Cancel a subscription
revkeen subscriptions cancel --id sub_xxxxxxxx

Payment links

# List payment links
revkeen payment-links list

# Create a payment link
revkeen payment-links create --product-id prod_xxxxxxxx

Transactions

# List transactions
revkeen transactions list

# Get a transaction
revkeen transactions get --id txn_xxxxxxxx

# Refund a transaction
revkeen transactions refund --id txn_xxxxxxxx --amount 2500

Webhook endpoints

# List webhook endpoints
revkeen webhook-endpoints list

# Create a webhook endpoint
revkeen webhook-endpoints create --url https://example.com/webhooks --events invoice.paid,payment.completed

Resource commands are generated from the OpenAPI specification. Run revkeen --help to see the full list, which updates as new API endpoints are added.

Custom commands

auth

Manage CLI authentication.

# Log in via browser-based OAuth
revkeen auth login

# Log in with an API key directly
revkeen auth login --api-key rk_live_your_api_key

# Log in in headless mode (no browser)
revkeen auth login --no-browser

# Show current auth status
revkeen auth status

# Remove stored credentials
revkeen auth logout

config

Manage CLI configuration stored at ~/.revkeen/config.toml.

# Set a config value
revkeen config set <key> <value>

# Show all config values
revkeen config list

Available config keys:

Key	Description	Example
`api-key`	Your RevKeen API key	`rk_live_xxx`
`base-url`	API base URL	`https://api.revkeen.com`
`output`	Default output format	`json`
`environment`	Target environment	`production`, `staging`

webhooks

Forward webhook events to a local URL for development and testing.

# Forward events to a local server
revkeen webhooks listen --forward-to http://localhost:3000/webhooks

# List registered webhook endpoints
revkeen webhooks list

webhooks listen creates a temporary webhook endpoint and streams events to your local URL. Press Ctrl+C to stop.

terminal

Manage POS terminal devices and initiate payments.

# Pair a PAX terminal device
revkeen terminal pair --serial <serial-number>

# Check connected terminal status
revkeen terminal status

# Initiate a payment on a terminal
revkeen terminal pay 50.00 --terminal term_xxxxxxxx

api

Make raw authenticated HTTP requests to any RevKeen API endpoint. This is an escape hatch for endpoints not yet available as named commands.

# GET request
revkeen api GET /v2/customers

# POST request with JSON body
revkeen api POST /v2/invoices -d '{"customerId":"cus_xxx","amount":5000}'

# DELETE request
revkeen api DELETE /v2/webhook-endpoints/we_xxx

# Pipe output to jq
revkeen api GET /v2/customers | jq '.data[].email'

Combining with shell tools

The CLI outputs structured data that works well with standard shell tools:

# Count customers
revkeen customers list --output json | jq '.data | length'

# Export invoices to CSV
revkeen invoices list --output csv > invoices.csv

# Get customer emails
revkeen customers list --output json | jq -r '.data[].email'

# Watch for new transactions
watch -n 30 revkeen transactions list --output table