CLI kurulum referansı

Bu sayfa, openclaw onboard için eksiksiz başvuru kaynağıdır. Kısa kılavuz için bkz. Onboarding (CLI).

Sihirbaz ne yapar

Yerel mod (varsayılan) size şunlarda rehberlik eder:

• 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 önyükleme dosyaları
• Gateway ayarları (port, bağlama, kimlik doğrulama, Tailscale)
• Kanallar ve sağlayıcılar (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, iMessage ve diğer paketli kanal Plugin'leri)
• Daemon kurulumu (LaunchAgent, systemd kullanıcı birimi veya Startup klasörü yedeğiyle yerel Windows Zamanlanmış Görevi)
• 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 şeyi 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 kimlikleri için görüntü desteğini çıkarımlar ve yalnızca model adı bilinmiyorsa sorar.
• Onboarding bir sağlayıcı kimlik doğrulama seçiminden başladığında, model seçici bu sağlayıcıyı otomatik olarak tercih eder. Volcengine ve BytePlus için aynı tercih bunların kodlama planı varyantlarıyla da eşleşir (volcengine-plan/*, byteplus-plan/*).
• Tercih edilen sağlayıcı filtresi boş olacaksa 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 aktarma: ~/.openclaw/credentials/oauth.json

Kimlik bilgisi depolama modu:

• Varsayılan onboarding davranışı, API anahtarlarını kimlik doğrulama profillerinde düz metin değerler olarak kalıcı hale getirir.
• --secret-input-mode ref, düz metin anahtar depolama yerine başvuru modunu etkinleştirir. Etkileşimli kurulumda şunlardan birini seçebilirsiniz:
  • ortam değişkeni başvurusu (örneğin keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • sağlayıcı takma adı + kimlik ile yapılandırılmış sağlayıcı başvurusu (file veya exec)
• Etkileşimli başvuru modu, kaydetmeden önce hızlı bir ön kontrol 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 kimliği çözümler.
  • Ön kontrol 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şlem 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 takdirde 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, CUSTOM_API_KEY değerinin ayarlanmış olmasını gerektirir; aksi takdirde onboarding hızlıca başarısız olur.
• Gateway kimlik doğrulama kimlik bilgileri, etkileşimli kurulumda düz metin ve SecretRef seçeneklerini destekler:
  • Token modu: Düz metin token üret/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ç işleyiş

~/.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 (ayarlanmadığında yerel ilk kurulum varsayılan olarak "coding" olur; mevcut açık değerler korunur)
• gateway.* (mod, bağlama, kimlik doğrulama, tailscale)
• session.dmScope (ayarlanmadığında yerel ilk kurulum 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.*
• İstemler sırasında katılmayı seçtiğinizde kanal izin listeleri (Slack, Discord, Matrix, Microsoft Teams) (mümkün olduğunda adlar kimliklere çözümlenir)
• skills.install.nodeManager
  • setup --node-manager bayrağı npm, pnpm veya bun kabul eder.
  • Manuel yapılandırma daha sonra yine 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), ilk 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
• Kullanılabilir olduğunda yerel derlemeler kullanılır
• Windows, WSL2 kullanır ve WSL içinde Linux signal-cli akışını izler

İlgili belgeler

• İlk kurulum merkezi: İlk Kurulum (CLI)
• Otomasyon ve betikler: CLI Otomasyonu
• Komut başvurusu: openclaw onboard