OrbitFlare CLI - OrbitFlare

The OrbitFlare CLI is the single entry point for everything a developer needs: streaming on-chain data via gRPC, querying the blockchain, scaffolding projects from templates, and managing your account through an interactive dashboard.

The CLI stores credentials in your OS keychain and supports multiple auth profiles, so you can switch between accounts or networks instantly.

Installation

Cargo (recommended)
From source

cargo install orbitflare

git clone https://github.com/orbitflare/orbit-cli.git
cd orbit-cli
cargo install --path .

Requires Rust 1.92+. Verify the installation:

orbitflare --version

Quick Start: Existing Users

If you already have an OrbitFlare account and API key from the dashboard:

# Authenticate with your API key
orbitflare auth login --x-orbit-key YOUR_API_KEY

# Pick the region closest to you (default: fra)
orbitflare config set region ams

# Verify everything works
orbitflare ping
orbitflare rpc slot

Endpoints default to the configured region (fra when unset), so ping, rpc, das, ws, jet and grpc work right after login. An explicit rpc.url, grpc.url or jetstream.url takes precedence over the region.

Endpoint URLs follow this format:

Protocol	Format	Example
RPC	`https://{region}.rpc.orbitflare.com`	`https://ams.rpc.orbitflare.com`
WS	`wss://{region}.rpc.orbitflare.com`	`wss://ams.rpc.orbitflare.com`
gRPC (Yellowstone)	`http://{region}.rpc.orbitflare.com:10000`	`http://ams.rpc.orbitflare.com:10000`
Jetstream	`http://{region}.jetstream.orbitflare.com`	`http://ams.jetstream.orbitflare.com`

RPC, WebSocket and Yellowstone regions: va, ny, la, slc, ams, fra, lon, jp, sg. Jetstream regions: ny, slc, ams, fra, lon, dub, sqq, jp, sgp; RPC regions without a Jetstream endpoint map to the nearest one (va → ny, la → slc, sg → sgp).

Quick Start: New Users

Create an Account

Authenticate

The CLI supports three login methods. Pick the one that suits your workflow:

# API key (from orbitflare.com/dashboard)
orbitflare auth login --x-orbit-key YOUR_API_KEY

# Solana wallet keypair
orbitflare auth login --wallet ~/.config/solana/id.json

# Device flow (opens browser)
orbitflare auth login

The CLI fetches and stores your RPC license key automatically during login. To set it manually:

orbitflare auth set-license-key YOUR_LICENSE_KEY

Keep your API key and license key secret. Do not commit them to version control or expose them in client-side code.

Configure Your Endpoints

Endpoints default to the fra region. Pick the region closest to you, or set full endpoint URLs from the Services section of your dashboard:

# Use a region for every service
orbitflare config set region ams

# (Optional) Set endpoints explicitly
orbitflare config set rpc.url ORBITFLARE_RPC_URL
orbitflare config set grpc.url ORBITFLARE_GRPC_URL
orbitflare config set jetstream.url ORBITFLARE_JETSTREAM_URL

# Verify connectivity
orbitflare ping

See Authentication & Limits for all available region endpoints.

Start Building

# Query your SOL balance
orbitflare rpc balance YOUR_WALLET_ADDRESS

# Get current slot
orbitflare rpc slot

# Wallet portfolio with token prices
orbitflare das owner YOUR_WALLET_ADDRESS

# Scaffold a project
orbitflare template --list
orbitflare template --install solana-copy-trader

# Launch the TUI dashboard
orbitflare dashboard

Authentication

Credentials are stored securely in your OS keychain. The CLI supports multiple named profiles so you can manage separate accounts or environments.

# Check current auth status
orbitflare auth status

# Switch profile
orbitflare auth switch --profile work

# Log out (also revokes device and wallet session tokens)
orbitflare auth logout

# Store an Apex API key for `apex send` and `apex transfer`
orbitflare auth set-apex-key YOUR_APEX_KEY

Auth Methods

API Key
Wallet
Device Flow

Authenticate with your API key from the dashboard. The key is passed via the X-ORBIT-KEY header to the Customer API.

orbitflare auth login --x-orbit-key YOUR_API_KEY

Authenticate by signing a challenge with your Solana keypair. If the wallet is not linked to an account, the CLI will walk you through registration.

orbitflare auth login --wallet ~/.config/solana/id.json

Opens your browser for OAuth-style authentication. Ideal for interactive use.

orbitflare auth login

The CLI displays a verification URL and code, polls for completion, then stores the session token automatically.

Key Resolution Order

--profile flag to select a stored profile
Default profile in ~/.orbitflare/config.yml
Environment variables: ORBITFLARE_LICENSE_KEY for RPC, ORBITFLARE_APEX_KEY for Apex

Command Reference

The CLI has top-level commands spanning authentication, configuration, blockchain queries, real-time streaming, project scaffolding, and account management.

Core Commands

Command	Description
`auth login`	Authenticate (API key, wallet, or device flow)
`auth logout`	Remove stored credentials
`auth status`	Show current authentication status
`auth switch --profile <NAME>`	Switch to a different auth profile
`auth set-license-key <KEY>`	Store RPC license key for current profile
`auth set-apex-key <KEY>`	Store Apex API key for current profile
`config show`	Display all configuration values
`config set <KEY> <VALUE>`	Set a configuration value
`config remove <KEY> <VALUE>`	Remove a value from a list config
`config reset`	Reset config to defaults (preserves auth)
`ping`	Check connectivity to all configured services
`ping --service <SVC>`	Ping a specific service (`rpc`, `jetstream`, `grpc`)
`docs [TOPIC...]`	Open documentation in your browser (`cli`, `rpc`, `ws`, `jet`, `grpc`, `das`, `history`, `apex`, `sdk`, `api`, or a docs path)
`plan list`	List available RPC plans
`plan view <SLUG>`	View plan details
`plan compare --all`	Compare all plans side by side
`pay check-balance`	Check account balance
`pay topup <AMOUNT>`	Top up balance with USDC (on-chain)
`pay history`	Top-up / credit history
`pay purchase <SLUG> <PERIOD>`	Purchase a plan from balance
`pay order --history`	List orders
`pay order <REF>`	View order details
`pay invoice --list`	List invoices
`pay invoice <REF>`	View invoice details
`pay renew <INVOICE>`	Pay invoice from balance (renewal)

RPC Commands

Query the Solana blockchain directly from your terminal.

orbitflare rpc account <ADDRESS>
orbitflare rpc tokens <WALLET>
orbitflare rpc balance <ADDRESS>
orbitflare rpc tx <SIGNATURE>
orbitflare rpc history <ADDRESS> --limit 20
orbitflare rpc program-accounts <PROGRAM_ID> --limit 10
orbitflare rpc slot
orbitflare rpc epoch
orbitflare rpc blockhash
orbitflare rpc stats
orbitflare rpc priority-fees --account <ADDRESS>
orbitflare rpc raw '{"jsonrpc":"2.0","id":1,"method":"getSlot","params":[]}'

rpc tokens lists Token and Token-2022 accounts. rpc history uses getTransactionsForAddress and takes filters and pagination:

# Oldest first, failed transactions only, from a date
orbitflare rpc history <ADDRESS> --oldest-first --status failed --since 2026-01-01

# Include token account activity, then fetch the next page
orbitflare rpc history <ADDRESS> --token-accounts balanceChanged --limit 100
orbitflare rpc history <ADDRESS> --page-token <TOKEN>

DAS Commands

Query tokens, NFTs and compressed NFTs through the Digital Asset Standard API. List commands take --limit (up to 1000) and --page.

# One or more assets by ID
orbitflare das asset <ID> [<ID>...]

# Wallet portfolio: SOL, priced tokens and NFTs
orbitflare das owner <WALLET>
orbitflare das owner <WALLET> --tokens
orbitflare das owner <WALLET> --nfts

# Search by owner, creator, authority, collection, name, type, compression or burn state
orbitflare das search --owner <WALLET> --token-type compressedNFT
orbitflare das search --creator <ADDRESS> --burnt false

# Assets in a collection, token accounts of a mint
orbitflare das collection <COLLECTION>
orbitflare das holders <MINT>

# Compressed asset Merkle proof and history
orbitflare das proof <ASSET_ID>
orbitflare das signatures <ASSET_ID>

Apex Commands

Send transactions through Apex. ping and tip-accounts need no key; send and transfer use the Apex API key from auth set-apex-key or ORBITFLARE_APEX_KEY.

orbitflare apex ping
orbitflare apex tip-accounts --region fra
orbitflare apex send <BASE64_TX> --region fra --confirm
orbitflare apex send --file tx.b64
orbitflare apex transfer <TO> <SOL> --wallet ~/.config/solana/id.json --tip 0.001

Regions: global, fra, ams, dub, lon, nyc, slc, sgp, tyo, sqq. Every transaction must carry exactly one top-level SystemProgram transfer of at least 0.001 SOL to an Apex tip account; send checks this before sending and transfer adds it for you.

WebSocket Commands

Subscribe to live Solana pubsub events over WebSocket. Each subscription runs until you press Ctrl+C and prints events as they arrive (use --json for machine-readable output).

# Live slot updates
orbitflare ws slot

# Account changes for a specific address
orbitflare ws account <ADDRESS>

# Transaction logs mentioning one or more addresses (omit --mentions for all)
orbitflare ws logs --mentions <ADDRESS> --mentions <ANOTHER>

# Confirmation of a single transaction signature
orbitflare ws signature <SIGNATURE>

The endpoint is derived from your RPC endpoint: http:// becomes ws:// and https:// becomes wss://. To target a different host for a single command, pass --ws-url:

orbitflare ws slot --ws-url wss://ams.rpc.orbitflare.com

Streaming Commands

Stream real-time Solana data over gRPC. Both commands take a YAML config file that defines your filters and reconnection strategy, stop on Ctrl+C or after --duration <SECONDS>, and print one JSON object per event with --json.

Jetstream
Yellowstone gRPC

orbitflare jet --config stream.yml

# Inline filters, no config file
orbitflare jet --required 6EF8rrecthR5Dkzon8Nwu78hRvfCKubJ14M5uBEwF6P --enrichment

# Slot lifecycle events (alive, complete, dead)
orbitflare jet --slots

Jetstream provides ultra-low-latency transaction streaming over the v2 protocol. Filters take account_include, account_exclude and account_required; Jetstream has no account filters, so use Yellowstone gRPC for account updates. --enrichment, or include_enrichment: true on any filter, adds the fee payer, compute-unit price and limit, priority fee, program IDs, writable accounts, transaction size and resolved lookup-table addresses. --v1 uses the deprecated v1 protocol.

stream.yml

transactions:
  pump_trades:
    account_include:
      - "6EF8rrecthR5Dkzon8Nwu78hRvfCKubJ14M5uBEwF6P"
    include_enrichment: true

reconnect:
  initial_delay_ms: 100
  max_delay_ms: 30000
  multiplier: 2.0
  max_retries: 0    # 0 = unlimited

orbitflare grpc --config grpc-stream.yml

Yellowstone provides the complete Geyser plugin data stream including slots and block metadata.

grpc-stream.yml

transactions:
  jupiter_swaps:
    account_include:
      - "JUP6LkbZbjS1jKKwapdHNy74zcZ3tLUZoi5QNyVTaV4"
    vote: false
    failed: false

slots:
  all_slots:
    filter_by_commitment: true

commitment: confirmed

reconnect:
  initial_delay_ms: 100
  max_delay_ms: 30000
  multiplier: 2.0
  max_retries: 0

Both streaming commands support automatic endpoint failover and exponential backoff reconnection. Environment variables can be used in config files with ${VAR} syntax.

Template Commands

Scaffold projects from production-ready starter templates.

# List all templates
orbitflare template --list

# Filter by language
orbitflare template --list --filter rust

# View template details
orbitflare template --view solana-copy-trader

# Install a template
orbitflare template --install solana-copy-trader --dir ./my-bot

Templates are fetched from the orbitflare/templates repository and cached locally for offline use.

Plan Commands

Browse and compare available RPC plans. Plan data is cached locally for 6 hours. Without a login the public catalog is shown.

# List all plans (sorted by price)
orbitflare plan list

# View plan details
orbitflare plan view <SLUG>

# Compare all plans side by side
orbitflare plan compare --all

# Compare specific plans
orbitflare plan compare dev growth scale

Payment Commands

Manage your account balance, purchase plans, and handle invoices. Only topup requires a Solana wallet — everything else uses your account balance.

# Check account balance
orbitflare pay check-balance

# Top up balance with USDC (on-chain)
orbitflare pay topup <AMOUNT> --wallet ~/.config/solana/id.json

# Top-up / credit history
orbitflare pay history

# Purchase a plan from balance
orbitflare pay purchase <SLUG> <PERIOD> --coupon <CODE>

# View orders
orbitflare pay order --history
orbitflare pay order <REFERENCE>

# View invoices
orbitflare pay invoice --list
orbitflare pay invoice <REFERENCE>

# Pay an invoice from balance (renewal)
orbitflare pay renew <INVOICE_REF>

The topup command defaults to ~/.config/solana/id.json for the wallet keypair. Use --wallet to specify a different path. Billing periods: monthly, quarterly, semi-annual, annual.

The purchase command runs a dry-run validation first, showing you the pricing breakdown and whether your balance is sufficient before confirming.

Dashboard

Launch an interactive TUI for managing your OrbitFlare account without leaving the terminal.

orbitflare dashboard

The dashboard provides full keyboard-driven access to your profile, services, API keys, and invoices. With a license key, the header shows live token prices from the DAS API.

Navigation keybinds

Key	Action
`q`	Quit
`Esc`	Back
`Tab`	Switch tab / focus
`↑↓` / `jk`	Navigate
`Enter`	Select / expand / toggle
`t` / `T`	Cycle theme
`[`	Toggle sidebar
`R`	Refresh data

Service management keybinds

Key	Tab	Action
`m`	Details	Toggle auth mode (IP / API Key)
`w`	Details	Toggle auto-renewal
`r`	Details	Regenerate license key
`n`	IPs / Domains	Switch Mainnet / Devnet
`a`	IPs / Domains	Add IP or domain
`d`	IPs / Domains	Remove IP or domain

API key management keybinds

Key	Action
`c`	Create new API key
`e`	Toggle enabled / disabled
`r`	Regenerate key
`x`	Delete key
`a`	Add IP (when expanded)
`d`	Remove IP (when expanded)

Invoice & profile keybinds

Key	Section	Action
`p`	Invoices	Pay with account balance
`e`	Profile	Edit name and payment wallet

JSON Output

All commands support --json for machine-readable output, making the CLI easy to integrate into scripts and automation pipelines.

orbitflare rpc slot --json
orbitflare rpc balance Gh9ZwEm... --json
orbitflare auth status --json

Example output:

{
  "confirmed": 312849571,
  "finalized": 312849539
}

Configuration

Configuration is stored in ~/.orbitflare/config.yml. Manage it with the config command:

# View current config
orbitflare config show

# Set network
orbitflare config set network devnet

# Set region for all default endpoints
orbitflare config set region ams

# Set RPC endpoint
orbitflare config set rpc.url https://ams.rpc.orbitflare.com

# Set gRPC and Jetstream endpoints
orbitflare config set grpc.url http://ams.rpc.orbitflare.com:10000
orbitflare config set jetstream.url http://ams.jetstream.orbitflare.com

# Set commitment level
orbitflare config set commitment finalized

# Change TUI theme
orbitflare config set theme dracula

# Set template repository
orbitflare config set templates.repo https://github.com/your-org/templates

# Reset to defaults
orbitflare config reset

Devnet endpoints are preconfigured by default:

RPC: https://devnet.rpc.orbitflare.com (fallback: https://api.devnet.solana.com)
gRPC: http://devnet.rpc.orbitflare.com:10000

Use --network devnet to switch at runtime. Jetstream is mainnet only.

File Locations

~/.orbitflare/
├── config.yml                  # Main configuration
├── templates_cache.json        # Template registry cache
└── cache/
    └── rpc-plans.json          # Plans cache (6-hour TTL)

API keys, tokens, and license keys are stored in your OS Keychain, not on disk.

Global Flags

These flags work with every command and override the corresponding config value for that invocation.

Flag	Description
`--json`	Output raw JSON
`--raw`	Minimal output, no formatting
`--network <NET>`	Override network (`mainnet` / `devnet`)
`--region <CODE>`	Region for default endpoints
`--commitment <C>`	Override commitment (`processed` / `confirmed` / `finalized`)
`--rpc-url <URL>`	Override RPC endpoint
`--grpc-url <URL>`	Override Yellowstone gRPC endpoint
`--jetstream-url <URL>`	Override Jetstream endpoint
`--ws-url <URL>`	Override WebSocket endpoint (default: derived from RPC URL)
`--fallback-url <URL>`	Fallback URLs (repeatable)
`--profile <NAME>`	Use a specific auth profile
`--quiet`	Suppress non-essential output
`--no-color`	Disable colored output

Full Workflow Example

A complete walkthrough from installation to querying:

# 1. Install the CLI
cargo install orbitflare

# 2. Authenticate
orbitflare auth login --x-orbit-key YOUR_API_KEY

# 3. Pick your region
orbitflare config set region ams

# 4. Verify connectivity
orbitflare ping

# 5. Query the blockchain
orbitflare rpc slot
orbitflare rpc balance YOUR_WALLET_ADDRESS

# 6. Scaffold a project
orbitflare template --install solana-copy-trader --dir ./my-bot

# 7. Stream real-time data
orbitflare jet --config stream.yml
orbitflare jet --required 6EF8rrecthR5Dkzon8Nwu78hRvfCKubJ14M5uBEwF6P --enrichment

What’s Next?

RPC Methods

Explore the full Solana RPC method reference.

Jetstream Streaming

Learn about real-time gRPC data streaming.

Yellowstone gRPC

Complete Geyser plugin data via Yellowstone.

Starter Templates

Browse production-ready project templates.

Support

Discord

Join the community for help and discussions.

GitHub

Report issues or contribute to the CLI.

​Installation

​Quick Start: Existing Users

​Quick Start: New Users

​Authentication

​Auth Methods

​Key Resolution Order

​Command Reference

​Core Commands

​RPC Commands

​DAS Commands

​Apex Commands

​WebSocket Commands

​Streaming Commands

​Template Commands

​Plan Commands

​Payment Commands

​Dashboard

​JSON Output

​Configuration

​File Locations

​Global Flags

​Full Workflow Example

​What’s Next?

RPC Methods

Jetstream Streaming

Yellowstone gRPC

Starter Templates

​Support

Discord

GitHub

Installation

Quick Start: Existing Users

Quick Start: New Users

Authentication

Auth Methods

Key Resolution Order

Command Reference

Core Commands

RPC Commands

DAS Commands

Apex Commands

WebSocket Commands

Streaming Commands

Template Commands

Plan Commands

Payment Commands

Dashboard

JSON Output

Configuration

File Locations

Global Flags

Full Workflow Example

What’s Next?

Support