OrbitFlare CLI - OrbitFlare

OrbitFlare CLI — единая точка входа для разработчика: стриминг ончейн-данных по gRPC, запросы к блокчейну, развёртывание проектов из шаблонов и управление аккаунтом через интерактивный дашборд.

CLI хранит учётные данные в связке ключей ОС и поддерживает несколько профилей аутентификации — можно мгновенно переключаться между аккаунтами или сетями.

Установка

Cargo (рекомендуется)
Из исходников

cargo install orbitflare

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

Требуется Rust 1.92+. Проверка установки:

orbitflare --version

Быстрый старт: у кого уже есть аккаунт

Если у вас уже есть аккаунт OrbitFlare и API-ключ из дашборда:

# 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

Эндпоинты по умолчанию берутся из заданного региона (fra, если регион не задан), поэтому ping, rpc, das, ws, jet и grpc работают сразу после входа. Явно заданные rpc.url, grpc.url или jetstream.url имеют приоритет над регионом.

URL эндпоинтов следуют формату:

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 и Yellowstone: va, ny, la, slc, ams, fra, lon, jp, sg. Регионы Jetstream: ny, slc, ams, fra, lon, dub, sqq, jp, sgp; регионы RPC без эндпоинта Jetstream сопоставляются с ближайшим (va → ny, la → slc, sg → sgp).

Быстрый старт: новые пользователи

Создайте аккаунт

Зарегистрируйтесь на orbitflare.com и выберите тариф.

Аутентификация

CLI поддерживает три способа входа — выберите подходящий:

# 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

При входе CLI загружает и сохраняет RPC license key автоматически. Задать его вручную:

orbitflare auth set-license-key YOUR_LICENSE_KEY

Храните API-ключ и license key в секрете. Не коммитьте их в репозиторий и не показывайте в клиентском коде.

Настройте эндпоинты

По умолчанию используется регион fra. Выберите ближайший регион или задайте полные URL эндпоинтов из раздела Services дашборда:

# 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

Список региональных эндпоинтов — в разделе Authentication & Limits.

Начните разработку

# 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

Аутентификация

Учётные данные хранятся в связке ключей ОС. Поддерживаются именованные профили для разных аккаунтов или окружений.

# 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

Способы входа

API Key
Wallet
Device Flow

Вход по API-ключу из дашборда. Ключ передаётся в Customer API заголовком X-ORBIT-KEY.

orbitflare auth login --x-orbit-key YOUR_API_KEY

Вход через подпись challenge вашим Solana keypair. Если кошелёк не привязан к аккаунту, CLI проведёт через регистрацию.

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

Открывает браузер для аутентификации в стиле OAuth. Удобно для интерактивной работы.

orbitflare auth login

CLI показывает URL верификации и код, опрашивает завершение и сохраняет session token автоматически.

Порядок разрешения ключей

--profile для выбора сохранённого профиля
Профиль по умолчанию в ~/.orbitflare/config.yml
Переменные окружения: ORBITFLARE_LICENSE_KEY для RPC, ORBITFLARE_APEX_KEY для Apex

Справочник команд

CLI покрывает аутентификацию, конфигурацию, запросы к блокчейну, стриминг в реальном времени, шаблоны и управление аккаунтом.

Основные команды

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

Запросы к блокчейну Solana напрямую из терминала.

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 выводит аккаунты Token и Token-2022. rpc history использует getTransactionsForAddress и поддерживает фильтры и пагинацию:

# 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

Запросы токенов, NFT и сжатых NFT через Digital Asset Standard API. Команды-списки принимают --limit (до 1000) и --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

Отправка транзакций через Apex. ping и tip-accounts не требуют ключа; send и transfer используют API-ключ Apex из auth set-apex-key или 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

Регионы: global, fra, ams, dub, lon, nyc, slc, sgp, tyo, sqq. Каждая транзакция должна содержать ровно один перевод SystemProgram верхнего уровня не менее 0,001 SOL на tip-аккаунт Apex; send проверяет это перед отправкой, а transfer добавляет перевод сам.

Команды WebSocket

Подписка на live Solana pubsub по WebSocket. Подписка работает до Ctrl+C, события печатаются по мере прихода (--json — машиночитаемый вывод).

# 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>

Эндпоинт выводится из RPC-эндпоинта: http:// → ws://, https:// → wss://. Для другого хоста на одну команду используйте --ws-url:

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

Команды стриминга

Поток данных Solana в реальном времени по gRPC. Обе команды принимают YAML с фильтрами и политикой переподключения, останавливаются по Ctrl+C или через --duration <SECONDS> и с --json выводят по одному 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 даёт транзакции с ультранизкой задержкой по протоколу v2. Фильтры принимают account_include, account_exclude и account_required; фильтров по аккаунтам в Jetstream нет, для обновлений аккаунтов используйте Yellowstone gRPC. --enrichment или include_enrichment: true в любом фильтре добавляет плательщика комиссии, цену и лимит вычислительных единиц, приоритетную комиссию, ID программ, записываемые аккаунты, размер транзакции и разрешённые адреса таблиц поиска. --v1 включает устаревший протокол v1.

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 — полный поток данных плагина Geyser, включая слоты и метаданные блоков.

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

Обе команды стриминга поддерживают автоматический failover эндпоинтов и экспоненциальный backoff при переподключении. В конфигах можно использовать переменные окружения синтаксисом ${VAR}.

Команды шаблонов

Развёртывание проектов из готовых стартовых шаблонов.

# 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

Шаблоны загружаются из репозитория orbitflare/templates и кешируются локально для офлайна.

Команды планов

Просмотр и сравнение доступных RPC-планов. Данные планов кешируются локально на 6 часов. Без входа показывается публичный каталог.

# 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

Команды оплаты

Баланс, покупка планов и счета. Только для topup нужен кошелёк Solana — остальное списывается с баланса аккаунта.

# 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>

По умолчанию для keypair кошелька в topup используется ~/.config/solana/id.json. Другой путь — через --wallet. Периоды биллинга: monthly, quarterly, semi-annual, annual.

Команда purchase сначала выполняет сухой прогон с разбивкой цены и проверкой, хватает ли баланса, прежде чем вы подтверждаете покупку.

Дашборд

Интерактивный TUI для управления аккаунтом OrbitFlare без выхода из терминала.

orbitflare dashboard

Полное управление с клавиатуры: профиль, сервисы, API-ключи, счета. С лицензионным ключом в шапке отображаются актуальные цены токенов из DAS API.

Навигация: горячие клавиши

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

Сервисы: горячие клавиши

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	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)

Счета и профиль: горячие клавиши

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

Вывод JSON

У всех команд есть --json для машиночитаемого вывода — удобно подключать CLI к скриптам и пайплайнам.

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

Пример:

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

Конфигурация

Конфиг хранится в ~/.orbitflare/config.yml. Управление через команду config:

# 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 преднастроены по умолчанию:

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

Переключение на лету: --network devnet. Jetstream работает только в mainnet.

Расположение файлов

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

API-ключи, токены и license keys хранятся в связке ключей ОС, не на диске в открытом виде для этого сценария.

Глобальные флаги

Работают с любой командой и переопределяют значение конфига на один вызов.

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

Полный пример сценария

От установки до запросов:

# 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

Что дальше?

Методы RPC

Полный справочник методов Solana RPC.

Стриминг Jetstream

gRPC-стриминг данных в реальном времени.

Yellowstone gRPC

Полный поток Geyser через Yellowstone.

Стартовые шаблоны

Готовые production-шаблоны проектов.

Поддержка

Discord

Сообщество: вопросы и обсуждения.

GitHub

Сообщения об ошибках и контрибуция в CLI.

​Установка

​Быстрый старт: у кого уже есть аккаунт

​Быстрый старт: новые пользователи

​Аутентификация

​Способы входа

​Порядок разрешения ключей

​Справочник команд

​Основные команды

​Команды RPC

​Команды DAS

​Команды Apex

​Команды WebSocket

​Команды стриминга

​Команды шаблонов

​Команды планов

​Команды оплаты

​Дашборд

​Вывод JSON

​Конфигурация

​Расположение файлов

​Глобальные флаги

​Полный пример сценария

​Что дальше?

Методы RPC

Стриминг Jetstream

Yellowstone gRPC

Стартовые шаблоны

​Поддержка

Discord

GitHub

Установка

Быстрый старт: у кого уже есть аккаунт

Быстрый старт: новые пользователи

Аутентификация

Способы входа

Порядок разрешения ключей

Справочник команд

Основные команды

Команды RPC

Команды DAS

Команды Apex

Команды WebSocket

Команды стриминга

Команды шаблонов

Команды планов

Команды оплаты

Дашборд

Вывод JSON

Конфигурация

Расположение файлов

Глобальные флаги

Полный пример сценария

Что дальше?

Поддержка