Skip to main content
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

Requires Rust 1.83+. 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

# Point the CLI to your RPC endpoint (from your dashboard)
orbitflare config set rpc.url ORBITFLARE_RPC_URL

# Verify everything works
orbitflare ping
orbitflare rpc slot
A fresh install starts with an empty config. After login, set at least rpc.url so commands like ping and rpc know where to connect. Your endpoint URLs are available in the Services section of your dashboard.
Endpoint URLs follow this format:
ProtocolFormatExample
RPChttp://{region}.rpc.orbitflare.comhttp://ams.rpc.orbitflare.com
WSws://{region}.rpc.orbitflare.comws://ams.rpc.orbitflare.com
gRPC (Yellowstone)http://{region}.rpc.orbitflare.com:10000http://ams.rpc.orbitflare.com:10000
Jetstreamhttp://{region}.jetstream.orbitflare.comhttp://ams.jetstream.orbitflare.com

​
Quick Start: New Users

1

Create an Account

Sign up at orbitflare.com and choose a plan.
2

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.
3

Configure Your Endpoints

A fresh install starts with an empty config. Point the CLI to your OrbitFlare endpoints:Your endpoint URLs are in the Services section of your dashboard. They follow the format http://{region}.rpc.orbitflare.com.
# Set your RPC endpoint
orbitflare config set rpc.url ORBITFLARE_RPC_URL

# (Optional) Set streaming endpoints
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.
4

Start Building

# Query your SOL balance
orbitflare rpc balance YOUR_WALLET_ADDRESS

# Get current slot
orbitflare rpc slot

# 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
orbitflare auth logout

​
Auth Methods

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

​
Key Resolution Order

  1. --x-orbit-key flag on the command (highest priority)
  2. --profile flag to select a stored profile
  3. Default profile in ~/.orbitflare/config.yml

​
Command Reference

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

​
Core Commands

CommandDescription
auth loginAuthenticate (API key, wallet, or device flow)
auth logoutRemove stored credentials
auth statusShow 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
config showDisplay all configuration values
config set <KEY> <VALUE>Set a configuration value
config remove <KEY> <VALUE>Remove a value from a list config
config resetReset config to defaults (preserves auth)
pingCheck connectivity to all configured services
ping --service <SVC>Ping a specific service (rpc, jetstream, grpc)
docs [TOPIC...]Open documentation in your browser

​
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 <WALLET> --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 <METHOD> [ARGS...] --params <JSON>

​
Streaming Commands

Stream real-time Solana data over gRPC. Both commands take a YAML config file that defines your filters and reconnection strategy. 
orbitflare jet --config stream.yml
Jetstream provides ultra-low-latency transaction and account streaming.
stream.yml
transactions:
  pump_trades:
    account_include:
      - "6EF8rrecthR5Dkzon8Nwu78hRvfCKubJ14M5uBEwF6P"

accounts:
  my_wallet:
    account:
      - "YOUR_WALLET_ADDRESS"

reconnect:
  initial_delay_ms: 100
  max_delay_ms: 30000
  multiplier: 2.0
  max_retries: 0    # 0 = unlimited
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.

​
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.
KeyTabAction
mDetailsToggle auth mode (IP / API Key)
wDetailsToggle auto-renewal
rDetailsRegenerate license key
nIPs / DomainsSwitch Mainnet / Devnet
aIPs / DomainsAdd IP or domain
dIPs / DomainsRemove IP or domain
KeyAction
cCreate new API key
eToggle enabled / disabled
rRegenerate key
xDelete key
aAdd IP (when expanded)
dRemove IP (when expanded)
KeySectionAction
pInvoicesPay with account balance
eProfileEdit 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 RPC endpoint
orbitflare config set rpc.url http://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: http://devnet.rpc.orbitflare.com (fallback: https://api.devnet.solana.com)
  • gRPC: http://devnet.rpc.orbitflare.com:10000
Use --network devnet to switch at runtime.

​
File Locations

~/.orbitflare/
├── config.yml                  # Main configuration
└── templates_cache.json        # Template registry cache
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.
FlagDescription
--jsonOutput raw JSON
--rawMinimal output, no formatting
--network <NET>Override network (mainnet / devnet / testnet)
--commitment <C>Override commitment (processed / confirmed / finalized)
--rpc-url <URL>Override RPC endpoint
--grpc-url <URL>Override gRPC endpoint
--fallback-url <URL>Fallback URLs (repeatable)
--profile <NAME>Use a specific auth profile
--quietSuppress non-essential output
--no-colorDisable 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. Configure endpoints (from your dashboard)
orbitflare config set rpc.url ORBITFLARE_RPC_URL
orbitflare config set grpc.url ORBITFLARE_GRPC_URL

# 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

​
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.