Guides
CLI kurulum başvurusu
Bu sayfa openclaw onboard için tam referanstır.
Kısa kılavuz için bkz. İlk Katılım (CLI).
Sihirbaz ne yapar
Yerel mod (varsayılan) sizi şunlardan 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 başlangıç dosyaları
- Gateway ayarları (bağlantı noktası, bağlama, kimlik doğrulama, tailscale)
- Kanallar ve sağlayıcılar (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, iMessage ve diğer paketlenmiş kanal pluginleri)
- Daemon kurulumu (LaunchAgent, systemd kullanıcı birimi veya Startup klasörü yedeğiyle yerel Windows Scheduled Task)
- Sağlık kontrolü
- 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ı
Mevcut yapılandırmayı algılama
~/.openclaw/openclaw.jsonvarsa, Koru, Değiştir veya Sıfırla'yı seçin.- Sihirbazı yeniden çalıştırmak, açıkça Sıfırla'yı seçmediğiniz (veya
--resetiletmediğiniz) sürece hiçbir şeyi silmez. - CLI
--resetvarsayılan olarakconfig+creds+sessionskullanır; çalışma alanını da kaldırmak için--reset-scope fullkullanı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
trashkullanır ve 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 ve kimlik doğrulama
- Tam seçenek matrisi Kimlik doğrulama ve model seçenekleri bölümündedir.
Çalışma alanı
- Varsayılan
~/.openclaw/workspace(yapılandırılabilir). - İlk çalıştırma başlangıç ritüeli için gereken çalışma alanı dosyalarını yerleştirir.
- Çalışma alanı düzeni: Ajan çalışma alanı.
Gateway
- Bağlantı noktası, bağlama, kimlik doğrulama modu ve tailscale erişimi için sorular sorar.
- Önerilen: local loopback için bile token kimlik doğrulamasını etkin tutun, böylece yerel WS istemcilerinin kimlik doğrulaması yapması gerekir.
- Token modunda, etkileşimli kurulum şunları sunar:
- Düz metin token oluştur/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>.- İlk katılım süreci ortamında boş olmayan bir env var gerektirir.
--gateway-tokenile birleştirilemez.
- Kimlik doğrulamayı yalnızca her yerel sürece tamamen güveniyorsanız devre dışı bırakın.
- local loopback olmayan bağlamalar yine de kimlik doğrulaması gerektirir.
Kanallar
- WhatsApp: isteğe bağlı QR ile oturum açma
- Telegram: bot token
- Discord: bot token
- Google Chat: hizmet hesabı JSON + webhook hedef kitlesi
- Mattermost: bot token + temel URL
- Signal: isteğe bağlı
signal-clikurulumu + hesap yapılandırması - iMessage:
imsgCLI yolu + Messages DB erişimi; Gateway Mac dışında çalıştığında bir SSH sarmalayıcısı kullanın - DM güvenliği: varsayılan eşleştirmedir. İlk DM bir kod gönderir; şu komutla onaylayın:
openclaw pairing approve <channel> <code>veya izin listeleri kullanın.
Daemon kurulumu
- macOS: LaunchAgent
- Oturum açmış kullanıcı oturumu gerektirir; başsız kullanım için özel bir LaunchDaemon kullanın (birlikte gönderilmez).
- Linux ve WSL2 üzerinden Windows: systemd kullanıcı birimi
- Sihirbaz, gateway'in oturum kapatıldıktan sonra da çalışır durumda kalması için
loginctl enable-linger <user>denemesi yapar. - sudo isteyebilir (
/var/lib/systemd/lingeryazar); önce sudo olmadan dener.
- Sihirbaz, gateway'in oturum kapatıldıktan sonra da çalışır durumda kalması için
- 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.
- Daha iyi denetleyici durumu sağladıkları için Scheduled Tasks tercih edilir.
- Çalışma zamanı seçimi: Node (önerilen; WhatsApp ve Telegram için gereklidir). Bun önerilmez.
Sağlık kontrolü
- Gateway'i başlatır (gerekirse) ve
openclaw healthçalıştırır. openclaw status --deep, desteklendiğinde kanal yoklamaları dahil olmak üzere canlı gateway sağlık yoklamasını durum çıktısına ekler.
Skills
- Kullanılabilir skills'i okur ve gereksinimleri kontrol eder.
- Node yöneticisini seçmenize izin verir: npm, pnpm veya bun.
- Gerekli yükleyici kullanılabilir olduğunda güvenilir paketlenmiş skills için isteğe bağlı bağımlılıkları kurar.
- Kullanılamayan Homebrew, uv ve Go yükleyicilerini atlar, ardından etkilenen
skills'i manuel kurulum rehberliğiyle gruplar. Eksik önkoşulları kurduktan sonra
openclaw doctorçalıştırın.
Bitir
- iOS, Android ve macOS uygulama seçenekleri dahil özet ve sonraki adımlar.
Uzak mod ayrıntıları
Uzak mod, bu makineyi başka bir yerdeki bir 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
Anthropic API anahtarı
Varsa ANTHROPIC_API_KEY kullanır veya bir anahtar ister, ardından daemon kullanımı için kaydeder.
OpenAI Code aboneliği (OAuth)
Tarayıcı akışı; code#state yapıştırın.
Model ayarlanmamışsa veya zaten OpenAI ailesindense Codex çalışma zamanı üzerinden agents.defaults.model değerini openai/gpt-5.5 olarak ayarlar.
OpenAI Code aboneliği (cihaz eşleştirme)
Kısa ömürlü cihaz koduyla tarayıcı eşleştirme akışı.
Model ayarlanmamışsa veya zaten OpenAI ailesindense Codex çalışma zamanı üzerinden agents.defaults.model değerini openai/gpt-5.5 olarak ayarlar.
OpenAI API anahtarı
Varsa OPENAI_API_KEY kullanır veya bir anahtar ister, ardından kimlik bilgisini kimlik doğrulama profillerinde saklar.
Model ayarlanmamışsa, openai/* ise veya eski Codex model ref'leriyse agents.defaults.model değerini openai/gpt-5.5 olarak ayarlar.
xAI (Grok) OAuth
Uygun SuperGrok veya X Premium hesapları için tarayıcıda oturum açma. Bu, çoğu
kullanıcı için önerilen xAI yoludur. OpenClaw ortaya çıkan kimlik doğrulama
profilini Grok modelleri, Grok web_search, x_search ve code_execution için saklar.
xAI (Grok) cihaz kodu
localhost geri çağrısı yerine kısa bir kodla uzak kullanım dostu tarayıcı oturum açma. Bunu SSH, Docker veya VPS ana makinelerinden kullanın.
xAI (Grok) API anahtarı
XAI_API_KEY ister ve xAI'ı bir model sağlayıcı olarak yapılandırır. Bunu
abonelik OAuth yerine xAI Console API anahtarı istediğinizde kullanın.
OpenCode
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.
API anahtarı (genel)
Anahtarı sizin için saklar.
Vercel AI Gateway
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-M3'tür; API anahtarı kurulumu
minimax/... kullanır, OAuth kurulumu ise minimax-portal/... kullanır.
Daha fazla ayrıntı: MiniMax.
StepFun
Yapılandırma, Çin veya küresel uç noktalarındaki StepFun standart ya da Step Plan için otomatik yazılır.
Standart şu anda step-3.5-flash içerir; 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.
Ollama (Bulut ve yerel açık modeller)
Önce Cloud + Local, Cloud only veya Local only ister.
Cloud only, https://ollama.com ile OLLAMA_API_KEY kullanır.
Ana makine destekli modlar temel URL ister (varsayılan http://127.0.0.1:11434), kullanılabilir modelleri keşfeder ve varsayılanlar önerir.
Cloud + Local, bu Ollama ana makinesinin bulut erişimi için oturum açmış olup olmadığını da kontrol eder.
Daha fazla ayrıntı: Ollama.
Moonshot ve Kimi Coding
Moonshot (Kimi K2) ve Kimi Coding yapılandırmaları otomatik yazılır. Daha fazla ayrıntı: Moonshot AI (Kimi + Kimi Coding).
Özel sağlayıcı
OpenAI uyumlu ve Anthropic uyumlu uç noktalarla çalışır.
Etkileşimli ilk katılım, 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şvuru kullan (ön kontrol doğrulamasıyla env ref veya yapılandırılmış sağlayıcı ref)
Etkileşimsiz bayraklar:
--auth-choice custom-api-key--custom-base-url--custom-model-id--custom-api-key(isteğe bağlı;CUSTOM_API_KEYdeğerine geri döner)--custom-provider-id(isteğe bağlı)--custom-compatibility <openai|openai-responses|anthropic>(isteğe bağlı; varsayılanopenai)--custom-image-input/--custom-text-input(isteğe bağlı; çıkarılan model giriş kabiliyetini geçersiz kılar)
Atla
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ı ve modeli elle girin.
- Özel sağlayıcı ilk katılımı, yaygın model kimlikleri için görsel desteğini çıkarır ve yalnızca model adı bilinmediğinde sorar.
- İlk katılım bir sağlayıcı kimlik doğrulama seçiminden başladığında, model seçici
o sağlayıcıyı otomatik olarak tercih eder. Volcengine ve BytePlus için aynı tercih
onların coding-plan varyantlarıyla da eşleşir (
volcengine-plan/*,byteplus-plan/*). - Bu tercih edilen sağlayıcı filtresi boş olacaksa, seçici hiç model göstermemek yerine tam kataloğa geri döner.
- Sihirbaz bir model kontrolü çalıştırır ve yapılandırılmış 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 ilk kurulum davranışı, API anahtarlarını kimlik doğrulama profillerinde düz metin değerler olarak kalıcılaştırır.
--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 referansı (ö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ı referansı (
fileveyaexec)
- ortam değişkeni referansı (örneğin
- Etkileşimli referans modu, kaydetmeden önce hızlı bir ön kontrol doğrulaması çalıştırır.
- Env referansları: geçerli ilk kurulum ortamında değişken adını + boş olmayan değeri doğrular.
- Sağlayıcı referansları: sağlayıcı yapılandırmasını doğrular ve istenen id'yi çözümler.
- Ön kontrol başarısız olursa, ilk kurulum hatayı gösterir ve yeniden denemenize izin verir.
- Etkileşimli olmayan modda,
--secret-input-mode refyalnızca env desteklidir.- Sağlayıcı env değişkenini ilk kurulum işlemi ortamında ayarlayın.
- Satır içi anahtar bayrakları (örneğin
--openai-api-key), o env değişkeninin ayarlanmış olmasını gerektirir; aksi halde ilk kurulum hızlıca başarısız olur. - Özel sağlayıcılar için, etkileşimli olmayan
refmodumodels.providers.<id>.apiKeydeğerini{ source: "env", provider: "default", id: "CUSTOM_API_KEY" }olarak depolar. - Bu özel sağlayıcı durumunda,
--custom-api-keyiçinCUSTOM_API_KEYayarlanmış olmalıdır; aksi halde ilk kurulum 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 oluştur/depolama (varsayılan) veya SecretRef kullan.
- Parola modu: düz metin veya SecretRef.
- Etkileşimli olmayan 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ç yapılar
~/.openclaw/openclaw.json içindeki tipik alanlar:
agents.defaults.workspace--skip-bootstrapgeçirildiğindeagents.defaults.skipBootstrapagents.defaults.model/models.providers(Minimax seçilirse)tools.profile(yerel ilk kurulum, ayarlanmamışsa varsayılan olarak"coding"kullanır; mevcut açık değerler korunur)gateway.*(mod, bağlama, kimlik doğrulama, tailscale)session.dmScope(yerel ilk kurulum, ayarlanmamışsa bunu varsayılan olarakper-channel-peeryapar; mevcut açık değerler korunur)channels.telegram.botToken,channels.discord.token,channels.matrix.*,channels.signal.*,channels.imessage.*- İstemler sırasında kabul ettiğinizde kanal izin listeleri (Slack, Discord, Matrix, Microsoft Teams) (mümkün olduğunda adlar ID'lere çözümlenir)
skills.install.nodeManagersetup --node-managerbayrağınpm,pnpmveyabunkabul eder.- Elle yapılandırma daha sonra hâlâ
skills.install.nodeManager: "yarn"ayarlayabilir.
wizard.lastRunAtwizard.lastRunVersionwizard.lastRunCommitwizard.lastRunCommandwizard.lastRunModewizard.securityAcknowledgedAt
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 depolanır.
Gateway sihirbazı RPC:
wizard.startwizard.nextwizard.cancelwizard.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 depolar - Yapılandırmaya
channels.signal.cliPathyazar - JVM derlemeleri Java 21 gerektirir
- Mevcut 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