Helius CLI - Helius Docs

The Helius CLI is a full-featured command-line interface for the Helius platform. It provides 95+ commands for account management, blockchain data queries, transaction sending, webhooks, real-time streaming, staking, ZK Compression, and more — with machine-readable JSON output for every command.

Using an MCP-compatible AI tool? The Helius MCP server is the recommended way for AI agents to interact with Helius — it provides 10 routed tools with structured inputs/outputs, including built-in account signup. Use the CLI for shell scripts, CI/CD pipelines, or when MCP is not available.

Installation

npm install -g helius-cli

Quick Start — Existing Users

If you already have a Helius API key, just set it and go:

helius config set-api-key YOUR_API_KEY

Get your key from dashboard.helius.dev. That’s it — skip the signup steps below.

Quick Start — New Users

All helius signup invocations require --email, --first-name, and --last-name — including the Agent plan.

Generate a keypair

helius keygen

Output:

✓ Keypair generated
Path: ~/.helius/keypair.json
Address: 7xKp...3nQm

To use this wallet, fund it with:
  • ~0.001 SOL for transaction fees
  • 1 USDC for Helius signup

The funding hint above only applies if you’ll use autopay — skip funding if you plan to pay via the hosted link.

Create account

Two payment modes: hosted link (pay from any wallet, nothing to fund) or autopay (pay USDC from the local keypair, which must hold ~0.001 SOL + the plan amount).

# Default: print a hosted payment link, pay with any wallet in the browser
helius signup --email you@example.com --first-name Jane --last-name Doe

# After paying via link, finalize the account
helius signup --resume

# Or autopay from the local keypair
helius signup --plan agent --pay --email you@example.com --first-name Jane --last-name Doe

Get your API keys and endpoints

helius projects
helius apikeys <project-id>
helius rpc <project-id>

Your API key is sensitive information that grants access to your Helius account. Never expose it in client-side code, public repos, or browser-accessible areas.

Plans & Pricing

You can purchase any Helius shared plan directly through the CLI. Pass --plan during signup or use helius upgrade later:

Plan	Price	Credits	`--plan` value
Agent	$1 one-time	1,000,000	`agent`
Developer	$49/mo	10,000,000	`developer`
Business	$499/mo	100,000,000	`business`
Professional	$999/mo	200,000,000	`professional`

The Agent plan (agent) is the default. It costs $1 (paid in USDC) to prevent abuse and gives you 1,000,000 credits. For higher rate limits and more credits, sign up with a paid plan or upgrade later.

# Default: Agent plan ($1)
helius signup --email you@example.com --first-name Jane --last-name Doe

# Developer plan ($49/mo)
helius signup --plan developer --email you@example.com --first-name Jane --last-name Doe

# Yearly billing (paid plans only)
helius signup --plan business --period yearly --email you@example.com --first-name Jane --last-name Doe

Upgrade an existing account

helius upgrade --plan developer --email you@example.com --first-name Jane --last-name Doe

Pay a renewal

When a subscription renewal is due (monthly or yearly), Helius creates a payment intent — a pending payment with a unique ID, amount, and expiration. You’ll receive the payment intent ID via email or the dashboard.

helius pay <payment-intent-id>

The command fetches the intent details, shows the amount and expiration, asks for confirmation, then sends the USDC payment from your keypair wallet.

Command Reference

The CLI provides 95+ commands across 14 categories. Every command supports --json for machine-readable output and --api-key <key> / --network <net> global overrides.

Full Command Reference

All 95+ commands — account management, blockchain queries, DAS API, wallet, webhooks, transaction sending, WebSockets, staking, ZK compression, and more

JSON Output Mode

Add --json to any command for machine-readable output:

helius projects --json
helius balance Gh9ZwEm... --json
helius asset owner 86xCnPe... --json

Example:

{
  "projects": [
    {
      "id": "67b9d260-726b-4ba3-8bb0-dbbf794641bf",
      "name": "My Project",
      "plan": "free"
    }
  ]
}

Exit Codes

Agents should check exit codes for reliable automation:

Code	Meaning
0	Success
1	General error
10	Not logged in
11	Keypair not found
20	Insufficient SOL
21	Insufficient USDC
30	No projects found
31	Project not found
40	API error

Configuration

Config is stored in ~/.helius/:

~/.helius/
├── config.json    # JWT token, API key, network, default project
└── keypair.json   # Solana keypair (if generated with keygen)

Manage config with:

helius config show              # View current config
helius config set-api-key <key> # Set API key
helius config set-network devnet # Switch to devnet
helius config set-project <id>  # Set default project
helius config clear             # Reset everything

API Key Resolution Order

API keys are resolved in this order:

--api-key <key> flag (per-command override)
HELIUS_API_KEY environment variable
~/.helius/config.json (set via helius config set-api-key)

Global Options

All commands accept these flags:

Flag	Description
`--api-key <key>`	Override the configured API key
`--network <net>`	Override the network (`mainnet` or `devnet`)
`--json`	Output in JSON format
`-k, --keypair <path>`	Path to keypair file (commands that require signing)

Full Agent Workflow

# Step 1: Generate keypair
helius keygen

# Step 2: Create account (default: hosted payment link, pay from any wallet)
helius signup --email you@example.com --first-name Jane --last-name Doe
helius signup --resume   # Finalize after paying via link
# Or autopay from the local keypair (requires ~0.001 SOL + plan USDC):
# helius signup --plan agent --pay --email you@example.com --first-name Jane --last-name Doe

# Step 3: Get API keys
helius projects
helius apikeys <project-id>

# Step 4: Get RPC endpoints
helius rpc <project-id>

# Step 5: Start querying
helius balance <address>
helius asset owner <wallet-address>
helius tx history <address> --limit 10

Next Steps

Agents Overview

API guidance, workflows, and error handling for agents

Helius MCP

Connect AI tools directly to Helius APIs

View Plans

Understand Helius plans and upgrade options

Dashboard

Monitor your API usage and manage keys

Support

Discord Community

Join our Discord for real-time help and community support

Email Support

Contact our support team directly

​Installation

​Quick Start — Existing Users

​Quick Start — New Users

​Plans & Pricing

​Signup with a specific plan

​Upgrade an existing account

​Pay a renewal

​Command Reference

Full Command Reference

​JSON Output Mode

​Exit Codes

​Configuration

​API Key Resolution Order

​Global Options

​Full Agent Workflow

​Next Steps

Agents Overview

Helius MCP

View Plans

Dashboard

​Support

Discord Community

Email Support

Installation

Quick Start — Existing Users

Quick Start — New Users

Plans & Pricing

Signup with a specific plan

Upgrade an existing account

Pay a renewal

Command Reference

JSON Output Mode

Exit Codes

Configuration

API Key Resolution Order

Global Options

Full Agent Workflow

Next Steps

Support