Ana içeriğe atla

CLI Kurulum Başvurusu

Bu sayfa, openclaw onboard için tam başvurudur. 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 abonelik OAuth’u, 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, bind, auth, tailscale)
  • Kanallar ve sağlayıcılar (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, BlueBubbles ve diğer paketli kanal eklentileri)
  • Daemon kurulumu (LaunchAgent, systemd kullanıcı birimi veya Startup klasörü geri dönüşüyle yerel Windows Scheduled Task)
  • Sağlık denetimi
  • Skills kurulumu
Uzak mod, bu makineyi başka bir yerdeki bir 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ı

1

Mevcut yapılandırma algılama

  • ~/.openclaw/openclaw.json mevcutsa Keep, Modify veya Reset seçeneklerinden birini belirleyin.
  • Sihirbazı yeniden çalıştırmak, siz açıkça Reset seçmedikçe (veya --reset geçmedikçe) hiçbir şeyi silmez.
  • CLI --reset varsayılan olarak config+creds+sessions kullanır; çalışma alanını da kaldırmak için --reset-scope full kullanın.
  • Yapılandırma geçersizse veya eski anahtarlar içeriyorsa, sihirbaz durur ve devam etmeden önce openclaw doctor çalıştırmanızı ister.
  • Reset, trash kullanır ve şu kapsamları sunar:
    • Yalnızca yapılandırma
    • Yapılandırma + kimlik bilgileri + oturumlar
    • Tam sıfırlama (çalışma alanını da kaldırır)
2

Model ve kimlik doğrulama

3

Çalışma alanı

  • Varsayılan ~/.openclaw/workspace (yapılandırılabilir).
  • İlk çalıştırma önyükleme ritüeli için gereken çalışma alanı dosyalarını tohumlar.
  • Çalışma alanı düzeni: Agent workspace.
4

Gateway

  • Port, bind, auth modu ve tailscale açığa çıkarma için istemde bulunur.
  • Önerilen: yerel WS istemcilerinin kimlik doğrulaması yapması gereksin diye loopback için bile token auth etkin kalsın.
  • Token modunda etkileşimli kurulum şunları sunar:
    • Düz metin token üret/sakla (varsayılan)
    • SecretRef kullan (isteğe bağlı)
  • Parola modunda etkileşimli kurulum, düz metin veya SecretRef depolamayı da destekler.
  • Etkileşimsiz token SecretRef yolu: --gateway-token-ref-env <ENV_VAR>.
    • Onboarding işlem ortamında boş olmayan bir env var gerektirir.
    • --gateway-token ile birlikte kullanılamaz.
  • Yalnızca her yerel işleme tamamen güveniyorsanız auth’u devre dışı bırakın.
  • Loopback dışı bind’ler yine de auth gerektirir.
5

Kanallar

  • WhatsApp: isteğe bağlı QR girişi
  • Telegram: bot token’ı
  • Discord: bot token’ı
  • Google Chat: hizmet hesabı JSON’u + webhook audience
  • Mattermost: bot token’ı + temel URL
  • Signal: isteğe bağlı signal-cli kurulumu + hesap yapılandırması
  • BlueBubbles: iMessage için önerilir; sunucu URL’si + parola + webhook
  • iMessage: eski imsg CLI yolu + DB erişimi
  • DM güvenliği: varsayılan eşleştirmedir. İlk DM bir kod gönderir; bunu openclaw pairing approve <channel> <code> ile onaylayın veya izin listelerini kullanın.
6

Daemon kurulumu

  • macOS: LaunchAgent
    • Oturum açmış kullanıcı oturumu gerektirir; başsız kullanım için özel bir LaunchDaemon kullanın (paketlenmez).
  • Linux ve Windows üzerinden WSL2: systemd kullanıcı birimi
    • Sihirbaz, gateway’in çıkış yaptıktan sonra da çalışmaya devam etmesi için loginctl enable-linger <user> çalıştırmayı dener.
    • Sudo isteyebilir (/var/lib/systemd/linger yazar); önce sudo olmadan dener.
  • Yerel Windows: önce Scheduled Task
    • Görev oluşturma reddedilirse OpenClaw, kullanıcı başına Startup klasörü oturum açma öğesine geri döner ve gateway’i hemen başlatır.
    • Scheduled Task’lar, daha iyi gözetici durumu sundukları için tercih edilmeye devam eder.
  • Çalışma zamanı seçimi: Node (önerilir; WhatsApp ve Telegram için gereklidir). Bun önerilmez.
7

Sağlık denetimi

  • Gateway’i başlatır (gerekirse) ve openclaw health çalıştırır.
  • openclaw status --deep, desteklendiğinde kanal sondaları dahil olmak üzere canlı gateway sağlık denetimini durum çıktısına ekler.
8

Skills

  • Kullanılabilir Skills’i okur ve gereksinimleri denetler.
  • Düğüm yöneticisini seçmenize izin verir: npm, pnpm veya bun.
  • İsteğe bağlı bağımlılıkları kurar (bazıları macOS’ta Homebrew kullanır).
9

Bitir

  • iOS, Android ve macOS uygulama seçenekleri dahil özet ve sonraki adımlar.
GUI algılanmazsa sihirbaz, tarayıcı açmak yerine Control UI için SSH port yönlendirme yönergelerini yazdırır. Control UI varlıkları eksikse sihirbaz bunları derlemeyi dener; geri dönüş yolu pnpm ui:build komutudur (UI bağımlılıklarını otomatik kurar).

Uzak mod ayrıntıları

Uzak mod, bu makineyi başka bir yerdeki bir gateway’e bağlanacak şekilde yapılandırır.
Uzak mod, uzak ana makinede hiçbir şey kurmaz veya değiştirmez.
Ayarladıklarınız:
  • Uzak gateway URL’si (ws://...)
  • Uzak gateway auth gerekiyorsa token (önerilir)
  • Gateway yalnızca loopback ise SSH tünelleme veya bir tailnet kullanın.
  • Keşif ipuçları:
    • macOS: Bonjour (dns-sd)
    • Linux: Avahi (avahi-browse)

Kimlik doğrulama ve model seçenekleri

Varsa ANTHROPIC_API_KEY kullanır veya bir anahtar ister, ardından daemon kullanımı için kaydeder.
Gateway ana makinesindeki yerel Claude CLI girişini yeniden kullanır ve model seçimini standart bir claude-cli/claude-* başvurusuna geçirir.Bu, openclaw onboard ve openclaw configure içinde kullanılabilir bir yerel geri dönüş yoludur. Üretim için Anthropic API anahtarını tercih edin.
  • macOS: “Claude Code-credentials” Keychain öğesini denetler
  • Linux ve Windows: varsa ~/.claude/.credentials.json dosyasını yeniden kullanır
macOS’ta launchd başlatmalarının engellenmemesi için “Always Allow” seçeneğini seçin.
~/.codex/auth.json mevcutsa sihirbaz bunu yeniden kullanabilir. Yeniden kullanılan Codex CLI kimlik bilgileri Codex CLI tarafından yönetilmeye devam eder; süre dolduğunda OpenClaw önce bu kaynağı yeniden okur ve sağlayıcı bunu yenileyebiliyorsa, yenilenmiş kimlik bilgisini sahipliği üstlenmek yerine yeniden Codex depolamasına yazar.
Tarayıcı akışı; code#state yapıştırın.Model ayarlanmamışsa veya openai/* ise agents.defaults.model değerini openai-codex/gpt-5.4 olarak ayarlar.
Varsa OPENAI_API_KEY kullanır veya bir anahtar ister, ardından kimlik bilgisini auth profillerinde saklar.Model ayarlanmamışsa, openai/* ise veya openai-codex/* ise agents.defaults.model değerini openai/gpt-5.4 olarak ayarlar.
XAI_API_KEY ister ve xAI’yi model sağlayıcısı olarak yapılandırır.
OPENCODE_API_KEY (veya OPENCODE_ZEN_API_KEY) ister ve Zen veya Go kataloğunu seçmenize izin verir. Kurulum URL’si: opencode.ai/auth.
Anahtarı sizin için saklar.
AI_GATEWAY_API_KEY ister. Daha fazla ayrıntı: Vercel AI Gateway.
Hesap kimliği, gateway kimliği ve CLOUDFLARE_AI_GATEWAY_API_KEY ister. Daha fazla ayrıntı: Cloudflare AI Gateway.
Yapılandırma otomatik yazılır. Barındırılan varsayılan MiniMax-M2.7’dir; API anahtarı kurulumu minimax/..., OAuth kurulumu ise minimax-portal/... kullanır. Daha fazla ayrıntı: MiniMax.
Yapılandırma, Çin veya küresel uç noktalarda StepFun standard veya Step Plan için otomatik yazılır. Standard şu anda step-3.5-flash içerir ve Step Plan ayrıca step-3.5-flash-2603 içerir. Daha fazla ayrıntı: StepFun.
SYNTHETIC_API_KEY ister. Daha fazla ayrıntı: Synthetic.
Temel URL ister (varsayılan http://127.0.0.1:11434), ardından Cloud + Local veya Local modunu sunar. Kullanılabilir modelleri keşfeder ve varsayılanlar önerir. Daha fazla ayrıntı: Ollama.
Moonshot (Kimi K2) ve Kimi Coding yapılandırmaları otomatik yazılır. Daha fazla ayrıntı: Moonshot AI (Kimi + Kimi Coding).
OpenAI uyumlu ve Anthropic uyumlu uç noktalarla çalışır.Etkileşimli onboarding, diğer sağlayıcı API anahtarı akışlarıyla aynı API anahtarı depolama seçeneklerini destekler:
  • API anahtarını şimdi yapıştır (düz metin)
  • Gizli başvuruyu kullan (env başvurusu veya yapılandırılmış sağlayıcı başvurusu, ön denetim doğrulamasıyla)
Etkileşimsiz bayraklar:
  • --auth-choice custom-api-key
  • --custom-base-url
  • --custom-model-id
  • --custom-api-key (isteğe bağlı; CUSTOM_API_KEY’e geri döner)
  • --custom-provider-id (isteğe bağlı)
  • --custom-compatibility <openai|anthropic> (isteğe bağlı; varsayılan openai)
Kimlik doğrulamayı yapılandırılmamış bırakır.
Model davranışı:
  • Algılanan seçeneklerden varsayılan modeli seçin veya sağlayıcı ile modeli elle girin.
  • Onboarding bir sağlayıcı auth seçiminden başlarsa, model seçici o sağlayıcıyı otomatik olarak tercih eder. Volcengine ve BytePlus için aynı tercih, bunların coding-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ılmış model bilinmiyorsa veya auth eksikse uyarır.
Kimlik bilgisi ve profil yolları:
  • Auth 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ı auth profillerinde düz metin değerler olarak kalıcılaştırır.
  • --secret-input-mode ref, düz metin anahtar depolama yerine başvuru modunu etkinleştirir. Etkileşimli kurulumda şu ikisinden 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ı + kimliği ile yapılandırılmış sağlayıcı başvurusu (file veya exec)
  • Etkileşimli başvuru modu, kaydetmeden önce hızlı bir ön denetim doğrulaması çalıştırır.
    • Env başvuruları: değişken adını + mevcut onboarding ortamında boş olmayan değeri doğrular.
    • Sağlayıcı başvuruları: sağlayıcı yapılandırmasını doğrular ve istenen kimliği çözümler.
    • Ön denetim başarısız olursa onboarding hatayı gösterir ve yeniden denemenize izin verir.
  • Etkileşimsiz modda --secret-input-mode ref yalnızca env desteklidir.
    • Sağlayıcı env var’ını onboarding işlem ortamında ayarlayın.
    • Satır içi anahtar bayrakları (örneğin --openai-api-key) bu env var’ın ayarlı 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, CUSTOM_API_KEY ayarlı olmasını gerektirir; aksi halde onboarding hızlıca başarısız olur.
  • Gateway auth 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.
Başsız ve sunucu ipucu: OAuth’u tarayıcısı olan bir makinede tamamlayın, sonra o ajanın auth-profiles.json dosyasını (örneğin ~/.openclaw/agents/<agentId>/agent/auth-profiles.json veya eşleşen $OPENCLAW_STATE_DIR/... yolu) gateway ana makinesine kopyalayın. credentials/oauth.json yalnızca eski bir içe aktarma kaynağıdır.

Çıktılar ve iç yapı

~/.openclaw/openclaw.json içindeki tipik alanlar:
  • agents.defaults.workspace
  • agents.defaults.model / models.providers (Minimax seçildiyse)
  • tools.profile (yerel onboarding, ayarlanmamışsa varsayılan olarak "coding" kullanır; mevcut açık değerler korunur)
  • gateway.* (mode, bind, auth, tailscale)
  • session.dmScope (yerel onboarding, ayarlanmamışsa 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ıldığınızda 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.
    • El ile 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ında bulunur. Oturumlar ~/.openclaw/agents/<agentId>/sessions/ altında saklanır.
Bazı kanallar eklenti olarak dağıtılır. Kurulum sırasında seçildiğinde sihirbaz, kanal yapılandırmasından önce eklentiyi kurmanızı ister (npm veya yerel yol).
Gateway sihirbaz RPC:
  • wizard.start
  • wizard.next
  • wizard.cancel
  • wizard.status
İstemciler (macOS uygulaması ve Control UI), onboarding mantığını yeniden uygulamadan adımları görüntü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
  • Mümkün olduğunda yerel derlemeler kullanılır
  • Windows, WSL2 kullanır ve WSL içinde Linux signal-cli akışını izler

İlgili belgeler