Skip to main content

Volr CLI

The create-volr is a command-line tool for setting up Volr projects, configuring checkout settings, and testing your integration. One command handles everything.

Quick Start​

npx create-volr

This runs the setup wizard that handles everything:

npx create-volr → auth → wallet → project → tokens → done!

No global install needed. The wizard walks you through:

  1. Sign in with your email (OTP)
  2. Connect your receiver wallet
  3. Create a checkout project (or select existing)
  4. Select accepted tokens (USDC, USDT, etc.)

After setup, you'll have a volr.json config and VOLR_SERVER_KEY in your .env.

Verify Your Setup​

volr checkout doctor

Why Use the CLI?​

  • One-command setup — npx create-volr creates your project, connects your wallet, and configures tokens
  • Health checks — volr checkout doctor validates your API key, webhook URL, and accepted tokens
  • Test payments — Create test checkouts on testnet without writing code
  • Skill installation — Install AI coding assistant skills for your IDE

Authentication​

The CLI uses email OTP authentication. After signing in, your session token is stored locally in ~/.volrrc.

volr auth login     # Log in
volr auth whoami    # Check current user
volr auth logout    # Log out

Non-Interactive Mode​

The CLI supports non-interactive usage for CI/CD pipelines and AI coding agents (Claude Code, Cursor, Codex).

Global Flags​

FlagDescription
--jsonOutput results as JSON

AI Agent Quick Start​

# Step 1: Send OTP
npx create-volr auth login --email dev@company.com --json

# Step 2: Verify OTP
npx create-volr auth verify --email dev@company.com --otp 482913 --json

# Step 3: Setup project
npx create-volr --project-name "my-app" --tokens "USDC:base" --skip-auth --json

Or pipe OTP in one command:

echo "482913" | npx create-volr --email dev@company.com --project-name "my-app" --tokens "USDC:base" --json

See CI & AI Agent Guide for the full walkthrough.

Next Steps​