Ana içeriğe atla

Documentation Index

Fetch the complete documentation index at: https://docs.orbitflare.com/llms.txt

Use this file to discover all available pages before exploring further.

OrbitFlare CLI, geliştiricinin ihtiyaç duyduğu her şey için tek giriş noktasıdır: gRPC üzerinden zincir üstü veriyi akışa alma, blokzinciri sorgulama, şablonlardan proje iskeleti çıkarma ve etkileşimli bir gösterge paneliyle hesabınızı yönetme.
CLI kimlik bilgilerinizi işletim sistemi anahtarlığında saklar ve birden çok kimlik profilini destekler; hesaplar veya ağlar arasında anında geçiş yapabilirsiniz.

Kurulum

cargo install orbitflare
Rust 1.85+ gerekir. Kurulumu doğrulayın:
orbitflare --version

Hızlı başlangıç: Mevcut kullanıcılar

Zaten gösterge panelinden bir OrbitFlare hesabınız ve API anahtarınız varsa:
# API anahtarınızla kimlik doğrulayın
orbitflare auth login --x-orbit-key YOUR_API_KEY

# CLI'yi RPC uç noktanıza yönlendirin (gösterge panelinden)
orbitflare config set rpc.url ORBITFLARE_RPC_URL

# Her şeyin çalıştığını doğrulayın
orbitflare ping
orbitflare rpc slot
Yeni kurulum boş bir yapılandırmayla başlar. Girişten sonra en azından rpc.url ayarlayın; böylece ping ve rpc gibi komutlar nereye bağlanacağını bilir. Uç nokta URL’leriniz gösterge panelinizin Hizmetler bölümündedir.
Uç nokta URL’leri şu biçimi kullanır:
ProtokolBiçimÖrnek
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

Hızlı başlangıç: Yeni kullanıcılar

1

Hesap oluşturun

orbitflare.com adresinden kaydolun ve bir plan seçin.
2

Kimlik doğrulayın

CLI üç giriş yöntemini destekler. İş akışınıza uygun olanı seçin:
# API anahtarı (orbitflare.com/dashboard)
orbitflare auth login --x-orbit-key YOUR_API_KEY

# Solana cüzdan anahtar çifti
orbitflare auth login --wallet ~/.config/solana/id.json

# Cihaz akışı (tarayıcıyı açar)
orbitflare auth login
CLI giriş sırasında RPC lisans anahtarınızı otomatik alır ve saklar. Elle ayarlamak için:
orbitflare auth set-license-key YOUR_LICENSE_KEY
API anahtarınızı ve lisans anahtarınızı gizli tutun. Sürüm denetimine eklemeyin veya istemci tarafı kodda açığa çıkarmayın.
3

Uç noktalarınızı yapılandırın

Yeni kurulum boş bir yapılandırmayla başlar. CLI’yi OrbitFlare uç noktalarınıza yönlendirin:Uç nokta URL’leriniz gösterge panelinizin Hizmetler bölümündedir. Biçim: http://{region}.rpc.orbitflare.com.
# RPC uç noktanızı ayarlayın
orbitflare config set rpc.url ORBITFLARE_RPC_URL

# (İsteğe bağlı) Akış uç noktalarını ayarlayın
orbitflare config set grpc.url ORBITFLARE_GRPC_URL
orbitflare config set jetstream.url ORBITFLARE_JETSTREAM_URL

# Bağlantıyı doğrulayın
orbitflare ping
Tüm bölge uç noktaları için Kimlik doğrulama ve limitler sayfasına bakın.
4

Geliştirmeye başlayın

# SOL bakiyenizi sorgulayın
orbitflare rpc balance YOUR_WALLET_ADDRESS

# Geçerli slotu alın
orbitflare rpc slot

# Projeyi iskeletleyin
orbitflare template --list
orbitflare template --install solana-copy-trader

# TUI gösterge panelini açın
orbitflare dashboard

Kimlik doğrulama

Kimlik bilgileri işletim sistemi anahtarlığında güvenle saklanır. CLI, ayrı hesapları veya ortamları yönetmek için birden çok adlandırılmış profil destekler.
# Geçerli kimlik durumunu kontrol edin
orbitflare auth status

# Profil değiştirin
orbitflare auth switch --profile work

# Oturumu kapatın
orbitflare auth logout

Kimlik doğrulama yöntemleri

Gösterge panelinizden aldığınız API anahtarıyla kimlik doğrulayın. Anahtar Müşteri API’sine X-ORBIT-KEY başlığıyla iletilir.
orbitflare auth login --x-orbit-key YOUR_API_KEY

Anahtar çözümleme sırası

  1. Komuttaki --x-orbit-key bayrağı (en yüksek öncelik)
  2. Saklı profili seçmek için --profile bayrağı
  3. ~/.orbitflare/config.yml içindeki varsayılan profil

Komut referansı

CLI’nin kimlik doğrulama, yapılandırma, blokzinciri sorguları, gerçek zamanlı akış, proje iskeleti ve hesap yönetimini kapsayan üst düzey komutları vardır.

Temel komutlar

KomutAçıklama
auth loginKimlik doğrulama (API anahtarı, cüzdan veya cihaz akışı)
auth logoutSaklı kimlik bilgilerini kaldırır
auth statusGeçerli kimlik doğrulama durumunu gösterir
auth switch --profile <NAME>Farklı bir kimlik profiline geçer
auth set-license-key <KEY>Geçerli profil için RPC lisans anahtarını saklar
config showTüm yapılandırma değerlerini gösterir
config set <KEY> <VALUE>Bir yapılandırma değerini ayarlar
config remove <KEY> <VALUE>Liste yapılandırmasından bir değeri kaldırır
config resetYapılandırmayı varsayılanlara sıfırlar (kimlik doğrulamayı korur)
pingYapılandırılmış tüm hizmetlere bağlantıyı kontrol eder
ping --service <SVC>Belirli bir hizmete ping (rpc, jetstream, grpc)
docs [TOPIC...]Dokümantasyonu tarayıcınızda açar
plan listMevcut RPC planlarını listeler
plan view <SLUG>Plan ayrıntılarını gösterir
plan compare --allTüm planları yan yana karşılaştırır
pay check-balanceHesap bakiyesini kontrol eder
pay topup <AMOUNT>USDC ile bakiye yükler (zincir üstü)
pay historyYükleme / kredi geçmişi
pay purchase <SLUG> <PERIOD>Bakiyeden plan satın alır
pay order --historySiparişleri listeler
pay order <REF>Sipariş ayrıntılarını gösterir
pay invoice --listFaturaları listeler
pay invoice <REF>Fatura ayrıntılarını gösterir
pay renew <INVOICE>Bakiyeden fatura öder (yenileme)

RPC komutları

Solana blokzincirini doğrudan terminalinizden sorgulayın.
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 '{"jsonrpc":"2.0","id":1,"method":"getSlot","params":[]}'

WebSocket komutları

WebSocket üzerinden canlı Solana pubsub olaylarına abone olun. Her abonelik Ctrl+C basana kadar çalışır ve olayları geldikçe yazdırır (makine tarafından okunabilir çıktı için --json kullanın).
# Canlı slot güncellemeleri
orbitflare ws slot

# Belirli bir adres için hesap değişiklikleri
orbitflare ws account <ADDRESS>

# Bir veya daha fazla adresi anan işlem günlükleri (--mentions atlanırsa tümü)
orbitflare ws logs --mentions <ADDRESS> --mentions <ANOTHER>

# Tek işlem imzasının onayı
orbitflare ws signature <SIGNATURE>
Uç nokta yapılandırılmış rpc.url değerinizden türetilir: http://ws://, https://wss://. Tek komutta farklı bir ana bilgisayar hedeflemek için --ws-url geçin:
orbitflare ws slot --ws-url ws://ams.rpc.orbitflare.com

Akış komutları

gRPC üzerinden gerçek zamanlı Solana verisini akışa alın. Her iki komut da filtrelerinizi ve yeniden bağlanma stratejinizi tanımlayan bir YAML yapılandırma dosyası alır.
orbitflare jet --config stream.yml
Jetstream ultra düşük gecikmeli işlem ve hesap akışı sağlar.
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 = sınırsız
Her iki akış komutu da otomatik uç nokta yedeklemesi ve üstel geri çekilme ile yeniden bağlanmayı destekler. Yapılandırma dosyalarında ${VAR} sözdizimi ile ortam değişkenleri kullanılabilir.

Şablon komutları

Üretime hazır başlangıç şablonlarından projeler iskeletleyin.
# Tüm şablonları listele
orbitflare template --list

# Dil ile filtrele
orbitflare template --list --filter rust

# Şablon ayrıntılarını görün
orbitflare template --view solana-copy-trader

# Şablon kur
orbitflare template --install solana-copy-trader --dir ./my-bot
Şablonlar orbitflare/templates deposundan alınır ve çevrimdışı kullanım için yerel önbelleğe alınır.

Plan komutları

Mevcut RPC planlarına göz atın ve karşılaştırın. Plan verisi yerel olarak 6 saat önbelleğe alınır.
# Tüm planları listele (fiyata göre sıralı)
orbitflare plan list

# Plan ayrıntılarını görüntüle
orbitflare plan view <SLUG>

# Tüm planları yan yana karşılaştır
orbitflare plan compare --all

# Belirli planları karşılaştır
orbitflare plan compare dev growth

Ödeme komutları

Hesap bakiyenizi yönetin, plan satın alın ve faturaları halledin. Yalnızca topup Solana cüzdanı gerektirir — geri kalanı hesap bakiyenizi kullanır.
# Hesap bakiyesini kontrol et
orbitflare pay check-balance

# USDC ile bakiye yükle (zincir üstü)
orbitflare pay topup <AMOUNT> --wallet ~/.config/solana/id.json

# Yükleme / kredi geçmişi
orbitflare pay history

# Bakiyeden plan satın al
orbitflare pay purchase <SLUG> <PERIOD> --coupon <CODE>

# Siparişleri görüntüle
orbitflare pay order --history
orbitflare pay order <REFERENCE>

# Faturaları görüntüle
orbitflare pay invoice --list
orbitflare pay invoice <REFERENCE>

# Bakiyeden fatura öde (yenileme)
orbitflare pay renew <INVOICE_REF>
topup komutu cüzdan anahtar çifti için varsayılan olarak ~/.config/solana/id.json kullanır. Farklı bir yol için --wallet kullanın. Faturalama dönemleri: monthly, quarterly, semi-annual, annual.
purchase komutu önce kuru bir doğrulama çalıştırır; onaylamadan önce fiyat dökümünü ve bakiyenizin yeterli olup olmadığını gösterir.

Gösterge paneli

Terminalden çıkmadan OrbitFlare hesabınızı yönetmek için etkileşimli bir TUI başlatın.
orbitflare dashboard
Gösterge paneli profilinize, hizmetlere, API anahtarlarına ve faturalara tam klavye ile erişim sağlar.
TuşEylem
qÇıkış
EscGeri
TabSekme / odak değiştir
↑↓ / jkGezin
EnterSeç / genişlet / aç-kapa
t / TTemayı değiştir
[Kenar çubuğunu aç-kapa
RVerileri yenile
TuşSekmeEylem
mAyrıntılarKimlik modunu aç-kapa (IP / API anahtarı)
wAyrıntılarOtomatik yenilemeyi aç-kapa
rAyrıntılarLisans anahtarını yeniden üret
nIP’ler / AlanlarMainnet / Devnet arasında geç
aIP’ler / AlanlarIP veya alan ekle
dIP’ler / AlanlarIP veya alan kaldır
TuşEylem
cYeni API anahtarı oluştur
eEtkin / devre dışı aç-kapa
rAnahtarı yeniden üret
xAnahtarı sil
aIP ekle (genişletilmişken)
dIP kaldır (genişletilmişken)
TuşBölümEylem
pFaturalarHesap bakiyesiyle öde
eProfilAdı ve ödeme cüzdanını düzenle

JSON çıktısı

Tüm komutlar makine tarafından okunabilir çıktı için --json destekler; böylece CLI betiklere ve otomasyon boru hatlarına kolayca entegre olur.
orbitflare rpc slot --json
orbitflare rpc balance Gh9ZwEm... --json
orbitflare auth status --json
Örnek çıktı:
{
  "confirmed": 312849571,
  "finalized": 312849539
}

Yapılandırma

Yapılandırma ~/.orbitflare/config.yml dosyasında saklanır. config komutuyla yönetin:
# Geçerli yapılandırmayı görüntüle
orbitflare config show

# Ağı ayarla
orbitflare config set network devnet

# RPC uç noktasını ayarla
orbitflare config set rpc.url http://ams.rpc.orbitflare.com

# gRPC ve Jetstream uç noktalarını ayarla
orbitflare config set grpc.url http://ams.rpc.orbitflare.com:10000
orbitflare config set jetstream.url http://ams.jetstream.orbitflare.com

# Taahhüt düzeyini ayarla
orbitflare config set commitment finalized

# TUI temasını değiştir
orbitflare config set theme dracula

# Şablon deposunu ayarla
orbitflare config set templates.repo https://github.com/your-org/templates

# Varsayılanlara sıfırla
orbitflare config reset
Devnet uç noktaları varsayılan olarak önceden yapılandırılmıştır:
  • RPC: http://devnet.rpc.orbitflare.com (yedek: https://api.devnet.solana.com)
  • gRPC: http://devnet.rpc.orbitflare.com:10000
Çalışma zamanında geçiş için --network devnet kullanın.

Dosya konumları

~/.orbitflare/
├── config.yml                  # Ana yapılandırma
├── templates_cache.json        # Şablon kayıt önbelleği
└── cache/
    └── rpc-plans.json          # Plan önbelleği (6 saat TTL)
API anahtarları, belirteçler ve lisans anahtarları işletim sistemi anahtarlığında saklanır, diskte değil.

Genel bayraklar

Bu bayraklar her komutta çalışır ve o çağrı için ilgili yapılandırma değerini geçersiz kılar.
BayrakAçıklama
--jsonHam JSON çıktısı
--rawMinimal çıktı, biçimlendirme yok
--network <NET>Ağı geçersiz kılar (mainnet / devnet / testnet)
--commitment <C>Taahhüdü geçersiz kılar (processed / confirmed / finalized)
--rpc-url <URL>RPC uç noktasını geçersiz kılar
--grpc-url <URL>gRPC uç noktasını geçersiz kılar
--ws-url <URL>WebSocket uç noktasını geçersiz kılar (varsayılan: RPC URL’sinden türetilir)
--fallback-url <URL>Yedek URL’ler (tekrarlanabilir)
--profile <NAME>Belirli bir kimlik profili kullan
--quietGereksiz olmayan çıktıyı bastır
--no-colorRenkli çıktıyı kapat

Tam iş akışı örneği

Kurulumdan sorguya kadar eksiksiz bir tur:
# 1. CLI'yi kur
cargo install orbitflare

# 2. Kimlik doğrula
orbitflare auth login --x-orbit-key YOUR_API_KEY

# 3. Uç noktaları yapılandır (gösterge panelinden)
orbitflare config set rpc.url ORBITFLARE_RPC_URL
orbitflare config set grpc.url ORBITFLARE_GRPC_URL

# 4. Bağlantıyı doğrula
orbitflare ping

# 5. Blokzinciri sorgula
orbitflare rpc slot
orbitflare rpc balance YOUR_WALLET_ADDRESS

# 6. Projeyi iskeletle
orbitflare template --install solana-copy-trader --dir ./my-bot

# 7. Gerçek zamanlı veriyi akışa al
orbitflare jet --config stream.yml

Sırada ne var?

RPC yöntemleri

Tam Solana RPC yöntemi referansını keşfedin.

Jetstream akışı

Gerçek zamanlı gRPC veri akışı hakkında bilgi edinin.

Yellowstone gRPC

Yellowstone ile tam Geyser eklentisi verisi.

Başlangıç şablonları

Üretime hazır proje şablonlarına göz atın.

Destek

Discord

Yardım ve tartışmalar için topluluğa katılın.

GitHub

Sorun bildirin veya CLI’ye katkıda bulunun.