English简体中文繁體中文日本語EspañolPortuguês (BR)한국어DeutschFrançaisالعربيةItalianoTiếng ViệtNederlandsTürkçeУкраїнськаBahasa IndonesiaPolskiفارسیไทย

Technical reference

İlk kurulum referansı

Bu, openclaw onboard için tam başvuru kaynağıdır. Üst düzey bir genel bakış için bkz. Onboarding (CLI).

Akış ayrıntıları (yerel mod)

  • Mevcut yapılandırma algılama

    • ~/.openclaw/openclaw.json varsa Tut / Değiştir / Sıfırla seçeneğini belirleyin.
    • Onboarding'i yeniden çalıştırmak, siz açıkça Sıfırla seçeneğini belirlemediğiniz sürece hiçbir şeyi silmez (veya --reset iletmediğiniz sürece).
    • 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.
    • Sıfırlama trash kullanır (asla rm değil) 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)

  • Model/Kimlik doğrulama

    • Anthropic API anahtarı: varsa ANTHROPIC_API_KEY kullanır veya bir anahtar ister, ardından daemon kullanımı için kaydeder.
    • Anthropic API anahtarı: onboarding/configure içinde tercih edilen Anthropic asistan seçimi.
    • Anthropic setup-token: OpenClaw artık kullanılabilir olduğunda Claude CLI yeniden kullanımını tercih etse de onboarding/configure içinde hâlâ kullanılabilir.
    • OpenAI Code (Codex) aboneliği (OAuth): tarayıcı akışı; code#state değerini yapıştırın.
      • Model ayarlanmamışsa veya zaten OpenAI ailesindeyse agents.defaults.model değerini openai-codex/gpt-5.5 olarak ayarlar.
    • OpenAI Code (Codex) aboneliği (cihaz eşleştirme): kısa ömürlü bir cihaz koduyla tarayıcı eşleştirme akışı.
      • Model ayarlanmamışsa veya zaten OpenAI ailesindeyse agents.defaults.model değerini openai-codex/gpt-5.5 olarak ayarlar.
    • OpenAI API anahtarı: varsa OPENAI_API_KEY kullanır veya bir anahtar ister, ardından bunu kimlik doğrulama profillerinde saklar.
      • Model ayarlanmamışsa, openai/* veya openai-codex/* ise agents.defaults.model değerini openai/gpt-5.5 olarak ayarlar.
    • xAI (Grok) API anahtarı: XAI_API_KEY ister ve xAI'ı model sağlayıcısı olarak yapılandırır.
    • OpenCode: OPENCODE_API_KEY (veya OPENCODE_ZEN_API_KEY, https://opencode.ai/auth adresinden alın) ister ve Zen veya Go kataloğunu seçmenizi sağlar.
    • Ollama: önce Bulut + Yerel, Yalnızca bulut veya Yalnızca yerel seçeneklerini sunar. Cloud only, OLLAMA_API_KEY ister ve https://ollama.com kullanır; ana makine destekli modlar Ollama temel URL'sini ister, kullanılabilir modelleri keşfeder ve gerektiğinde seçili yerel modeli otomatik olarak çeker; Cloud + Local ayrıca o Ollama ana makinesinin bulut erişimi için oturum açıp açmadığını denetler.
    • Daha fazla ayrıntı: Ollama
    • API anahtarı: anahtarı sizin için saklar.
    • Vercel AI Gateway (çok modelli proxy): AI_GATEWAY_API_KEY ister.
    • Daha fazla ayrıntı: Vercel AI Gateway
    • Cloudflare AI Gateway: Hesap Kimliği, Gateway Kimliği ve CLOUDFLARE_AI_GATEWAY_API_KEY ister.
    • Daha fazla ayrıntı: Cloudflare AI Gateway
    • MiniMax: yapılandırma otomatik yazılır; barındırılan varsayılan MiniMax-M2.7 olur. API anahtarı kurulumu minimax/... kullanır ve OAuth kurulumu minimax-portal/... kullanır.
    • Daha fazla ayrıntı: MiniMax
    • StepFun: yapılandırma, Çin veya küresel uç noktalarda StepFun standart ya da Step Plan için otomatik yazılır.
    • Standart ş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 (Anthropic uyumlu): SYNTHETIC_API_KEY ister.
    • Daha fazla ayrıntı: Synthetic
    • Moonshot (Kimi K2): yapılandırma otomatik yazılır.
    • Kimi Coding: yapılandırma otomatik yazılır.
    • Daha fazla ayrıntı: Moonshot AI (Kimi + Kimi Coding)
    • Atla: henüz kimlik doğrulama yapılandırılmaz.
    • Algılanan seçeneklerden varsayılan bir model seçin (veya sağlayıcı/modeli elle girin). En iyi kalite ve daha düşük prompt enjeksiyonu riski için sağlayıcı yığınınızda kullanılabilen en güçlü son nesil modeli seçin.
    • Onboarding bir model denetimi çalıştırır ve yapılandırılan model bilinmiyorsa veya kimlik doğrulaması eksikse uyarır.
    • API anahtarı saklama modu varsayılan olarak düz metin kimlik doğrulama profili değerlerini kullanır. Bunun yerine env destekli başvurular saklamak için --secret-input-mode ref kullanın (örneğin keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" }).
    • Kimlik doğrulama profilleri ~/.openclaw/agents/<agentId>/agent/auth-profiles.json içinde bulunur (API anahtarları + OAuth). ~/.openclaw/credentials/oauth.json yalnızca eski içe aktarma kaynağıdır.
    • Daha fazla ayrıntı: /concepts/oauth

  • Çalışma alanı

    • Varsayılan ~/.openclaw/workspace (yapılandırılabilir).
    • Ajan bootstrap ritüeli için gereken çalışma alanı dosyalarını oluşturur.
    • Tam çalışma alanı düzeni + yedekleme kılavuzu: Ajan çalışma alanı

  • Gateway

    • Port, bind, kimlik doğrulama modu, tailscale dışa açma.
    • Kimlik doğrulama önerisi: local loopback için bile Token seçeneğini koruyun; böylece yerel WS istemcileri kimlik doğrulamak zorunda kalır.
    • Token modunda, etkileşimli kurulum şunları sunar:
      • Düz metin token oluştur/sakla (varsayılan)
      • SecretRef kullan (isteğe bağlı)
      • Hızlı başlangıç, onboarding probe/dashboard bootstrap için env, file ve exec sağlayıcıları genelinde mevcut gateway.auth.token SecretRef'lerini yeniden kullanır.
      • Bu SecretRef yapılandırılmış ancak çözümlenemiyorsa, onboarding çalışma zamanı kimlik doğrulamasını sessizce zayıflatmak yerine açık bir düzeltme mesajıyla erken başarısız olur.
    • Parola modunda, etkileşimli kurulum düz metin veya SecretRef saklamayı da destekler.
    • Etkileşimsiz token SecretRef yolu: --gateway-token-ref-env &lt;ENV_VAR&gt;.
      • Onboarding işlem ortamında boş olmayan bir env var gerektirir.
      • --gateway-token ile birleştirilemez.
    • Kimlik doğrulamayı yalnızca her yerel işleme tamamen güveniyorsanız devre dışı bırakın.
    • local loopback olmayan bind'lar yine de kimlik doğrulama gerektirir.

  • Kanallar

    • WhatsApp: isteğe bağlı QR oturum açma.
    • Telegram: bot token'ı.
    • Discord: bot token'ı.
    • Google Chat: hizmet hesabı JSON'u + webhook hedef kitlesi.
    • Mattermost (plugin): 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; openclaw pairing approve <channel> <code> ile onaylayın veya izin listeleri kullanın.

  • Web araması

    • Brave, DuckDuckGo, Exa, Firecrawl, Gemini, Grok, Kimi, MiniMax Search, Ollama Web Search, Perplexity, SearXNG veya Tavily gibi desteklenen bir sağlayıcı seçin (veya atlayın).
    • API destekli sağlayıcılar hızlı kurulum için env var'ları veya mevcut yapılandırmayı kullanabilir; anahtarsız sağlayıcılar bunun yerine sağlayıcıya özgü önkoşullarını kullanır.
    • --skip-search ile atlayın.
    • Daha sonra yapılandırın: openclaw configure --section web.

  • Daemon kurulumu

    • macOS: LaunchAgent
      • Oturum açmış bir kullanıcı oturumu gerektirir; başsız kullanım için özel bir LaunchDaemon kullanın (gönderilmez).
    • Linux (ve WSL2 üzerinden Windows): systemd kullanıcı birimi
      • Onboarding, Gateway'in çıkıştan sonra açık kalması için loginctl enable-linger <user> ile lingering'i etkinleştirmeyi dener.
      • Sudo isteyebilir (/var/lib/systemd/linger yazar); önce sudo olmadan dener.
    • Çalışma zamanı seçimi: Node (önerilir; WhatsApp/Telegram için gereklidir). Bun önerilmez.
    • Token kimlik doğrulaması bir token gerektiriyorsa ve gateway.auth.token SecretRef tarafından yönetiliyorsa, daemon kurulumu bunu doğrular ancak çözümlenmiş düz metin token değerlerini supervisor hizmet ortamı meta verilerine kalıcı olarak yazmaz.
    • Token kimlik doğrulaması bir token gerektiriyorsa ve yapılandırılan token SecretRef çözümlenmemişse, daemon kurulumu uygulanabilir yönlendirmeyle engellenir.
    • Hem gateway.auth.token hem de gateway.auth.password yapılandırılmışsa ve gateway.auth.mode ayarlanmamışsa, mod açıkça ayarlanana kadar daemon kurulumu engellenir.

  • Sağlık denetimi

    • Gateway'i başlatır (gerekirse) ve openclaw health çalıştırır.
    • İpucu: openclaw status --deep, desteklendiğinde kanal probe'ları dahil canlı gateway sağlık probe'unu durum çıktısına ekler (erişilebilir bir gateway gerektirir).

  • Skills (önerilir)

    • Kullanılabilir skills'i okur ve gereksinimleri denetler.
    • Bir node yöneticisi seçmenizi sağlar: npm / pnpm (bun önerilmez).
    • İsteğe bağlı bağımlılıkları kurar (bazıları macOS'ta Homebrew kullanır).

  • Bitiş

    • Ek özellikler için iOS/Android/macOS uygulamaları dahil özet + sonraki adımlar.

    • Etkileşimsiz mod

    Onboarding'i otomatikleştirmek veya betiklemek için --non-interactive kullanın:

    openclaw onboard --non-interactive \
  --mode local \
  --auth-choice apiKey \
  --anthropic-api-key "$ANTHROPIC_API_KEY" \
  --gateway-port 18789 \
  --gateway-bind loopback \
  --install-daemon \
  --daemon-runtime node \
  --skip-skills

    Makine tarafından okunabilir bir özet için --json ekleyin.

    Etkileşimsiz modda Gateway token SecretRef:

    export OPENCLAW_GATEWAY_TOKEN="your-token"
openclaw onboard --non-interactive \
  --mode local \
  --auth-choice skip \
  --gateway-auth token \
  --gateway-token-ref-env OPENCLAW_GATEWAY_TOKEN

    --gateway-token ve --gateway-token-ref-env birbirini dışlar.

    Sağlayıcıya özgü komut örnekleri CLI Otomasyonu içinde bulunur. Bayrak semantiği ve adım sıralaması için bu başvuru sayfasını kullanın.

    Ajan ekle (etkileşimsiz)

    openclaw agents add work \
  --workspace ~/.openclaw/workspace-work \
  --model openai/gpt-5.5 \
  --bind whatsapp:biz \
  --non-interactive \
  --json

    Gateway sihirbaz RPC'si

    Gateway, onboarding akışını RPC üzerinden sunar (wizard.start, wizard.next, wizard.cancel, wizard.status). İstemciler (macOS uygulaması, Control UI), onboarding mantığını yeniden uygulamadan adımları işleyebilir.

    Signal kurulumu (signal-cli)

    Onboarding, GitHub releases üzerinden signal-cli kurabilir:

    • Uygun release varlığını indirir.
    • Bunu ~/.openclaw/tools/signal-cli/<version>/ altında saklar.
    • Yapılandırmanıza channels.signal.cliPath yazar.

    Notlar:

    • JVM derlemeleri Java 21 gerektirir.
    • Yerel derlemeler kullanılabilir olduğunda kullanılır.
    • Windows WSL2 kullanır; signal-cli kurulumu WSL içinde Linux akışını izler.

    Sihirbazın yazdıkları

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

    • agents.defaults.workspace
    • agents.defaults.model / models.providers (Minimax seçildiyse)
    • tools.profile (yerel ilk kurulum, ayarlanmadığında varsayılan olarak "coding" kullanır; mevcut açık değerler korunur)
    • gateway.* (mod, bağlama, kimlik doğrulama, tailscale)
    • session.dmScope (davranış ayrıntıları: CLI Kurulum Başvurusu)
    • channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
    • İstemler sırasında tercih ettiğinizde kanal izin listeleri (Slack/Discord/Matrix/Microsoft Teams) (adlar mümkün olduğunda kimliklere çözümlenir).
    • skills.install.nodeManager
      • setup --node-manager, npm, pnpm veya bun kabul eder.
      • Manuel yapılandırma, skills.install.nodeManager doğrudan ayarlanarak hâlâ yarn kullanabilir.
    • 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.

    Bazı kanallar Plugin olarak teslim edilir. Kurulum sırasında birini seçtiğinizde, ilk kurulum yapılandırılmadan önce onu yüklemenizi ister (npm veya yerel bir yol).

    İlgili belgeler