CLI Commands

Complete reference for all create-volr commands.

init (npx create-volr)

The setup wizard. This is the recommended way to get started with Volr.

npx create-volr

The wizard runs through all setup steps in order:

1. Authentication — Sign in with email (OTP verification)
2. Wallet — Connect your receiver wallet via browser
3. Project — Create a new checkout project or select an existing one
4. Tokens — Choose which stablecoins to accept (USDC, USDT, etc.)

After completion, creates:

• volr.json — Project configuration
• .env with VOLR_SERVER_KEY — Server API key

Non-Interactive Flags

Flag	Description
--email <email>	Email for OTP authentication
--project-name <name>	Project name (skip prompt)
--tokens <list>	Accepted tokens, e.g. USDC:base,USDT:polygon
--skip-auth	Skip authentication (use existing session)
--json	JSON output

auth

Manage authentication.

volr auth login      # Log in to your Volr account
volr auth logout     # Log out and clear stored credentials
volr auth whoami     # Display current authenticated user

auth login (non-interactive)

Send OTP to an email without browser interaction:

volr auth login --email dev@company.com [--json]

Or pipe OTP for one-step login:

echo "482913" | volr auth login --email dev@company.com [--json]

Flag	Description
--email <email>	Send OTP to this email
--token <token>	Provide auth token directly
--base-url <url>	Set custom API base URL

auth verify

Verify an OTP code (step 2 of non-interactive login):

volr auth verify --email dev@company.com --otp 482913 [--json]

Flag	Required	Description
--email <email>	Yes	Email address used for OTP
--otp <code>	Yes	The 6-digit OTP code

checkout

Manage checkout configuration and testing.

checkout setup

Interactive setup for updating checkout configuration and accepted tokens:

volr checkout setup

Configures and saves to volr.json:

• Accepted tokens and chains
• Webhook URL and secret
• Success/cancel redirect URLs

checkout doctor

Validate your checkout configuration:

volr checkout doctor

Checks:

• Server API key validity
• Webhook URL reachability
• Webhook secret is set
• Merchant address is configured
• Accepted tokens are set

Example output:

Volr Checkout Doctor
====================
✓ Server key is valid
✓ Webhook URL is reachable (https://mysite.com/webhooks/volr)
✓ Webhook secret is configured
✓ Merchant address is set (0x1234...abcd)
✓ Accepted tokens: USDC, USDT on Base

All checks passed! Your checkout integration is ready.

checkout create-test

Create a test checkout on Base Sepolia:

volr checkout create-test

Creates a test checkout with a small amount on the testnet. Useful for verifying your webhook handler without real funds.

checkout tokens list

List available tokens for checkout:

volr checkout tokens list [--json]

checkout tokens set

Set accepted tokens non-interactively:

volr checkout tokens set "USDC:base,USDT:polygon" [--json]

Token format: SYMBOL:chain where chain is one of: ethereum, base, polygon, arbitrum, optimism, avalanche.

skill

Manage AI IDE skills.

volr skill install    # Install Volr skills for your AI IDE
volr skill list       # List available skills

skill install

Detects your IDE and installs the appropriate skill files:

• Claude Code — .claude/skills/ directory
• Cursor — .cursor/rules/ directory
• Codex — AGENTS.md file
• Windsurf — .windsurfrules file

Global Options

Flag	Description
--json	Output all results as JSON (for CI/AI agents)
--help	Show help for any command
--version	Show CLI version