Skip to main content
HEVN CLI is a standalone command-line wrapper for the HEVN backend API and app-scoped transfer endpoints. It is built primarily for AI agents and automation that need scriptable access to HEVN account data and payment workflows, while still providing human-readable terminal output for operators, finance teams, and developers.

Quickstart

Install the CLI, sign in, and confirm your account in a few commands.

Configuration

Configure environments, API keys, output formats, and debugging.

Agent workflows

Load the agent skill, inspect the CLI manifest, and run workflows safely.

Money movement

Check balances, create deposit quotes, pay invoices, and transfer to contacts.

Contracts

Upload existing contracts, generate HEVN templates, approve contracts, and manage payment methods.

​
What you can do

  • Authenticate with hevn login and store a local app API key.
  • Inspect account, KYC, balance, card, bank, contact, invoice, and contract state.
  • Create contacts for email, crypto, and fiat payout destinations.
  • Create invoices manually, from uploaded invoice documents, or from contracts.
  • Generate HEVN contracts from templates or upload existing signed contracts.
  • Move USDC by invoice, email recipient, contact, or payout quote.
  • Emit human-readable tables or machine-readable JSON/YAML envelopes for automation.
  • Print an agent-readable command manifest with hevn --schema.

​
Command shape

Most commands follow this pattern: 
hevn [global-options] <resource> <action> [options]
Common global options: 
hevn --env dev account get
hevn --base-url https://api.example.com/api/v1 account get
hevn --debug transfer --invoice-id <invoice-id>
hevn --dry-run transfer --invoice-id <invoice-id>
hevn --non-interactive --yaml contacts list
Most read and write commands also support command-local output flags: 
--json
--yaml
Use these flags for scripts, agent tools, CI jobs, and data extraction. In JSON/YAML mode, successful command output is wrapped as ok, data, meta, and warnings; error output is wrapped as ok, errorCode, errorType, error, and exitCode.

​
Authentication model

hevn login opens the HEVN app in a browser, creates or selects an app, issues an app API key, and saves it in your local HEVN CLI config. Automation can save a key directly: 
hevn login --api-key hvn_...
One hvn_... API key is used for every authenticated endpoint, including transfers. The default header is Authorization: Bearer hvn_...; set HEVN_API_KEY_HEADER=X-Api-Key only when your backend deployment requires that header.
Transfer commands no longer require an app id. The backend resolves the owning app from the API key.