CLI kurulum referansı

Bu sayfa, openclaw onboard için tam referanstır. Kısa kılavuz için bkz. Onboarding (CLI).

# Sihirbaz ne yapar

Yerel mod (varsayılan) sizi şu adımlardan geçirir:

• Model ve kimlik doğrulama kurulumu (OpenAI Code aboneliği OAuth, Anthropic Claude CLI veya API anahtarı, ayrıca MiniMax, GLM, Ollama, Moonshot, StepFun ve AI Gateway seçenekleri)
• Çalışma alanı konumu ve bootstrap dosyaları
• Gateway ayarları (bağlantı noktası, bind, kimlik doğrulama, Tailscale)
• Kanallar ve sağlayıcılar (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, BlueBubbles ve diğer paketli kanal Pluginleri)
• Daemon kurulumu (LaunchAgent, systemd kullanıcı birimi veya Başlangıç klasörü yedeğiyle yerel Windows Scheduled Task)
• Sağlık denetimi
• Skills kurulumu

Uzak mod, bu makineyi başka bir yerdeki Gateway’e bağlanacak şekilde yapılandırır. Uzak ana makinede hiçbir şey kurmaz veya değiştirmez.

# Yerel akış ayrıntıları

# Uzak mod ayrıntıları

Uzak mod, bu makineyi başka bir yerdeki Gateway’e bağlanacak şekilde yapılandırır.

Ayarladıklarınız:

• Uzak Gateway URL’si (ws://...)
• Uzak Gateway kimlik doğrulaması gerekiyorsa token (önerilir)

# Kimlik doğrulama ve model seçenekleri

Model davranışı:

• Algılanan seçeneklerden varsayılan modeli seçin veya sağlayıcı ve modeli elle girin.
• Özel sağlayıcı onboarding, yaygın model ID’leri için görüntü desteğini çıkarır ve yalnızca model adı bilinmiyorsa sorar.
• Onboarding bir sağlayıcı kimlik doğrulama seçimiyle başladığında, model seçici o sağlayıcıyı otomatik olarak tercih eder. Volcengine ve BytePlus için aynı tercih onların kodlama planı varyantlarıyla da eşleşir (volcengine-plan/*, byteplus-plan/*).
• Bu tercih edilen sağlayıcı filtresi boş olursa, seçici hiç model göstermemek yerine tam kataloğa geri döner.
• Sihirbaz bir model denetimi çalıştırır ve yapılandırılan model bilinmiyorsa veya kimlik doğrulaması eksikse uyarır.

Kimlik bilgisi ve profil yolları:

• Kimlik doğrulama profilleri (API anahtarları + OAuth): ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
• Eski OAuth içe aktarımı: ~/.openclaw/credentials/oauth.json

Kimlik bilgisi depolama modu:

• Varsayılan onboarding davranışı, API anahtarlarını kimlik doğrulama profillerinde düz metin değerleri olarak kalıcı hale getirir.
• --secret-input-mode ref, düz metin anahtar depolama yerine referans modunu etkinleştirir. Etkileşimli kurulumda şunlardan birini seçebilirsiniz:
  • ortam değişkeni ref (örneğin keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • sağlayıcı takma adı + id ile yapılandırılmış sağlayıcı ref (file veya exec)
• Etkileşimli referans modu, kaydetmeden önce hızlı bir ön denetim doğrulaması çalıştırır.
  • Env refs: geçerli onboarding ortamında değişken adını + boş olmayan değeri doğrular.
  • Provider refs: sağlayıcı yapılandırmasını doğrular ve istenen id değerini çözümler.
  • Ön denetim başarısız olursa, onboarding hatayı gösterir ve yeniden denemenizi sağlar.
• Etkileşimsiz modda, --secret-input-mode ref yalnızca env desteklidir.
  • Sağlayıcı env var değerini onboarding işlemi ortamında ayarlayın.
  • Satır içi anahtar bayrakları (örneğin --openai-api-key) ilgili env var değerinin ayarlanmış olmasını gerektirir; aksi halde onboarding hızlıca başarısız olur.
  • Özel sağlayıcılar için etkileşimsiz ref modu, models.providers.<id>.apiKey değerini { source: "env", provider: "default", id: "CUSTOM_API_KEY" } olarak saklar.
  • Bu özel sağlayıcı durumunda, --custom-api-key için CUSTOM_API_KEY değerinin ayarlanmış olması gerekir; aksi halde onboarding hızlıca başarısız olur.
• Gateway kimlik doğrulama bilgileri, etkileşimli kurulumda düz metin ve SecretRef seçeneklerini destekler:
  • Token modu: Düz metin token oluştur/sakla (varsayılan) veya SecretRef kullan.
  • Parola modu: düz metin veya SecretRef.
• Etkileşimsiz token SecretRef yolu: --gateway-token-ref-env <ENV_VAR>.
• Mevcut düz metin kurulumlar değişmeden çalışmaya devam eder.

# Çıktılar ve iç ayrıntılar

~/.openclaw/openclaw.json içindeki tipik alanlar:

• agents.defaults.workspace
• --skip-bootstrap geçirildiğinde agents.defaults.skipBootstrap
• agents.defaults.model / models.providers (Minimax seçildiyse)
• tools.profile (yerel başlangıç kurulumu, ayarlı değilse varsayılan olarak "coding" kullanır; mevcut açık değerler korunur)
• gateway.* (mod, bağlama, kimlik doğrulama, tailscale)
• session.dmScope (yerel başlangıç kurulumu, ayarlı değilse bunu varsayılan olarak per-channel-peer yapar; mevcut açık değerler korunur)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• İstemlerde katılmayı seçtiğinizde kanal izin listeleri (Slack, Discord, Matrix, Microsoft Teams) (adlar mümkün olduğunda kimliklere çözümlenir)
• skills.install.nodeManager
  • setup --node-manager bayrağı npm, pnpm veya bun kabul eder.
  • Manuel yapılandırma daha sonra yine de skills.install.nodeManager: "yarn" ayarlayabilir.
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode

openclaw agents add, agents.list[] ve isteğe bağlı bindings yazar.

WhatsApp kimlik bilgileri ~/.openclaw/credentials/whatsapp/<accountId>/ altına gider. Oturumlar ~/.openclaw/agents/<agentId>/sessions/ altında saklanır.

Gateway sihirbazı RPC:

• wizard.start
• wizard.next
• wizard.cancel
• wizard.status

İstemciler (macOS uygulaması ve Control UI), başlangıç kurulum mantığını yeniden uygulamadan adımları işleyebilir.

Signal kurulum davranışı:

• Uygun sürüm varlığını indirir
• Bunu ~/.openclaw/tools/signal-cli/<version>/ altında saklar
• Yapılandırmaya channels.signal.cliPath yazar
• JVM derlemeleri Java 21 gerektirir
• Yerel derlemeler mevcut olduğunda kullanılır
• Windows, WSL2 kullanır ve WSL içinde Linux signal-cli akışını izler

# İlgili belgeler

• Başlangıç kurulumu merkezi: Başlangıç kurulumu (CLI)
• Otomasyon ve betikler: CLI Otomasyonu
• Komut başvurusu: openclaw onboard