Guides
CLI kurulum referansı
Bu sayfa, adım adım ilk katılım davranışını, çıktılarını ve iç işleyişini kapsar.
Adım adım açıklama için İlk Katılım (CLI) sayfasına bakın. Tam CLI bayrak
referansı (tüm --flag, etkileşimsiz örnekler, sağlayıcıya özgü
komutlar) için openclaw onboard sayfasına bakın.
Sihirbaz ne yapar?
Yerel mod (varsayılan) aşağıdaki adımlarda size yol gösterir:
- Model ve kimlik doğrulama kurulumu (Anthropic, OpenAI Code aboneliği OAuth, xAI, OpenCode, özel uç noktalar ve sağlayıcıların yönettiği diğer kimlik doğrulama akışları)
- Ç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 (Discord, Feishu, Google Chat, iMessage, Mattermost, Microsoft Teams, QQ Bot, Signal, Slack, Telegram, WhatsApp ve diğer paketlenmiş kanallar veya plugin kanalları)
- Web araması sağlayıcısı (isteğe bağlı)
- Arka plan hizmeti kurulumu (LaunchAgent, systemd kullanıcı birimi veya Başlangıç klasörü geri dönüşüne sahip yerel Windows Zamanlanmış Görevi)
- Sistem durumu denetimi
- Skills kurulumu
Uzak mod, bu makineyi başka bir yerdeki Gateway'e bağlanacak şekilde yapılandırır. Uzak ana bilgisayara hiçbir şey yüklemez veya orada hiçbir şeyi değiştirmez.
Yerel akış ayrıntıları
Mevcut yapılandırmayı algılama
~/.openclaw/openclaw.jsonmevcutsa Geçerli değerleri koru, İncele ve güncelle veya Kurulumdan önce sıfırla seçeneklerinden birini belirleyin.- Sihirbazı yeniden çalıştırmak, açıkça Sıfırla seçeneğini belirlemediğiniz (veya
--resetiletmediğiniz) sürece hiçbir şeyi silmez. - CLI
--resetvarsayılan olarakconfig+creds+sessionsdeğerini kullanı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 doctorkomutunu çalıştırmanızı ister. - Sıfırlama, durumu Çöp Kutusu'na taşır (asla doğrudan silmez) 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 ve kimlik doğrulama
- Seçeneklerin tam 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ıcı için gereken çalışma alanı dosyalarını oluşturur.
- Yeniden çalıştırıldığında, mevcut bir ajan listesi, siz taşımayı açıkça onaylamadığınız sürece filo genelindeki çalışma alanını korur. Etkileşimsiz yeniden çalıştırmalar uyarı verir ve geçerli değeri korur.
- Ç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 bilgi ister.
- Önerilen: yerel WS istemcilerinin kimlik doğrulaması gerekmesi için geri döngüde bile belirteç kimlik doğrulamasını etkin tutun.
- Belirteç modunda etkileşimli kurulum şunları sunar:
- Düz metin belirteci 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 belirteç SecretRef yolu:
--gateway-token-ref-env <ENV_VAR>.- İlk katılım işlemi ortamında boş olmayan bir ortam değişkeni gerektirir.
--gateway-tokenile birlikte kullanılamaz.
- Kimlik doğrulamayı yalnızca tüm yerel işlemlere tamamen güveniyorsanız devre dışı bırakın.
- Geri döngü dışı bağlamalar yine de kimlik doğrulama gerektirir.
Kanallar
- WhatsApp: isteğe bağlı QR ile oturum açma
- Telegram: bot belirteci
- Discord: bot belirteci
- Google Chat: hizmet hesabı JSON'u + webhook hedef kitlesi
- Mattermost: bot belirteci + temel URL
- Signal: isteğe bağlı
signal-clikurulumu + hesap yapılandırması - iMessage:
imsgCLI yolu + Messages veritabanı erişimi; Gateway Mac dışında çalışırken bir SSH sarmalayıcısı kullanın - DM güvenliği: varsayılan eşleştirmedir. İlk DM bir kod gönderir; bunu
openclaw pairing approve <channel> <code>aracılığıyla onaylayın veya izin listelerini kullanın.
Web araması
- Bir sağlayıcı seçin (Brave, DuckDuckGo, Exa, Firecrawl, Gemini, Grok, Kimi, MiniMax Search, Ollama Web Search, Perplexity, SearXNG, Tavily) veya atlayın.
- Bu adımı
--skip-searchile atlayın; daha sonraopenclaw configure --section webile yeniden yapılandırın.
Arka plan hizmeti kurulumu
- macOS: LaunchAgent
- Oturum açmış bir kullanıcı oturumu gerektirir; başsız kullanım için özel bir LaunchDaemon kullanın (birlikte sunulmaz).
- WSL2 üzerinden Linux ve Windows: systemd kullanıcı birimi
- Sihirbaz, oturum kapatıldıktan sonra Gateway'in çalışmaya devam etmesi için
loginctl enable-linger <user>işlemini dener. - sudo isteyebilir (
/var/lib/systemd/lingerdosyasına yazar); önce sudo olmadan dener.
- Sihirbaz, oturum kapatıldıktan sonra Gateway'in çalışmaya devam etmesi için
- Yerel Windows: önce Zamanlanmış Görev
- Görev oluşturmaya izin verilmezse OpenClaw, kullanıcı başına Başlangıç klasörü oturum açma öğesine geri döner ve Gateway'i hemen başlatır.
- Daha iyi gözetmen durumu sağladıkları için Zamanlanmış Görevler tercih edilmeye devam eder.
- Çalışma zamanı seçimi: OpenClaw'ın standart çalışma zamanı durum deposu
node:sqlitekullandığından Node gereklidir.
Sistem durumu denetimi
- Gateway'i başlatır (gerekirse) ve
openclaw healthkomutunu çalıştırır. openclaw status --deep, desteklendiğinde kanal yoklamaları da dahil olmak üzere canlı Gateway sistem durumu yoklamasını durum çıktısına ekler.
Skills
- Mevcut Skills öğelerini okur ve gereksinimleri denetler.
- Node yöneticisini seçmenizi sağlar: npm, pnpm veya bun.
- Gerekli yükleyici mevcut olduğunda güvenilir paketlenmiş Skills öğelerinin isteğe bağlı bağımlılıklarını yükler.
- Kullanılamayan Homebrew, uv ve Go yükleyicilerini atlar, ardından etkilenen
Skills öğelerini manuel kurulum yönergeleriyle gruplandırır. Eksik
ön koşulları yükledikten sonra
openclaw doctorkomutunu çalıştırın.
Tamamlama
- 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 Gateway'e bağlanacak şekilde yapılandırır. Uzak ana bilgisayara hiçbir şey yüklemez veya orada hiçbir şeyi değiştirmez.
Ayarladıklarınız:
- Uzak Gateway URL'si (
ws://...veyawss://...) - Uzak Gateway yapılandırmasıyla eşleşen belirteç, parola veya kimlik doğrulamasız erişim
Keşif (isteğe bağlı)
dns-sd (macOS) veya avahi-browse (Linux) mevcutsa ilk katılım,
manuel URL girişine geri dönmeden önce Bonjour/mDNS Gateway işaretçilerini
aramayı önerir. Yapılandırılmışsa geniş alan DNS-SD keşfi de
denenir. Belgeler: Gateway keşfi, Bonjour.
Bağlantı yöntemi
Bir işaretçi seçildiğinde doğrudan WebSocket veya SSH tüneli seçin:
- Doğrudan:
wss://üzerinden bağlanır ve keşfedilen TLS parmak izine güvenmenizi ister (ilk kullanımda güven sabitlemesi; yalnızca kabul ederseniz sabitlenir). - SSH tüneli: önce çalıştırılacak bir
ssh -N -L 18789:127.0.0.1:18789 <user>@<host>komutu yazdırır, ardından yerel tünel uç noktasına bağlanır.
Kimlik doğrulama
Belirteç (önerilen), parola veya kimlik doğrulamasız erişimi seçin, ardından isteğe bağlı olarak bunu düz metin yerine SecretRef olarak saklayın.
Kimlik doğrulama ve model seçenekleri
Etkileşimli ilk katılım sırasında bir sağlayıcı kurulum adımı başarısız olursa (örneğin yerel oturum açma
olmadan CLI yeniden kullanım seçeneği), sihirbaz çıkmak yerine hatayı gösterir ve sağlayıcı seçicisine
döner. Açık --auth-choice çalıştırmaları otomasyon için yine hızlıca başarısız olur.
Anthropic API anahtarı
Varsa ANTHROPIC_API_KEY kullanır veya bir anahtar ister, ardından arka plan hizmetinde kullanılması için kaydeder.
Anthropic Claude CLI
Etkileşimli ilk katılım/yapılandırmada tercih edilen yerel yoldur; mevcut olduğunda var olan Claude CLI oturumunu yeniden kullanır.
OpenAI Code aboneliği (OAuth)
Tarayıcı akışı; code#state öğesini yapıştırın.
Birincil modeli olmayan yeni bir kurulumda agents.defaults.model değerini
Codex çalışma zamanı aracılığıyla openai/gpt-5.6-sol olarak ayarlar.
OpenAI Code aboneliği (cihaz eşleştirme)
Kısa ömürlü cihaz koduyla tarayıcı eşleştirme akışı.
Birincil modeli olmayan yeni bir kurulumda agents.defaults.model değerini
Codex çalışma zamanı aracılığıyla openai/gpt-5.6-sol olarak ayarlar.
OpenAI API anahtarı
Varsa OPENAI_API_KEY kullanır veya bir anahtar ister, ardından kimlik bilgisini kimlik doğrulama profillerinde saklar.
Birincil modeli olmayan yeni bir kurulumda agents.defaults.model değerini
openai/gpt-5.6 olarak ayarlar; yalın doğrudan API model kimliği Sol katmanına çözümlenir.
OpenAI eklemek veya kimlik doğrulamasını yenilemek, openai/gpt-5.5 dahil olmak üzere mevcut açık birincil
modeli korur. Hesap GPT-5.6 erişimi sunmuyorsa
openai/gpt-5.5 seçeneğini açıkça belirleyin; OpenClaw bunu sessizce daha düşük bir sürüme geçirmez.
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 yöntemidir. OpenClaw, elde edilen kimlik doğrulama
profilini Grok modelleri, Grok web_search, x_search ve code_execution için saklar.
xAI (Grok) cihaz kodu
Localhost geri çağırması yerine kısa bir kodla, uzak bağlantılara uygun tarayıcıda oturum açma. Bunu SSH, Docker veya VPS ana makinelerinden kullanın.
xAI (Grok) API anahtarı
XAI_API_KEY ister ve xAI'ı model sağlayıcısı olarak yapılandırır. Abonelik
OAuth'ı yerine bir xAI Console API anahtarı istediğinizde bunu kullanın.
OpenCode
OPENCODE_API_KEY (veya OPENCODE_ZEN_API_KEY) ister ve Zen ya da Go kataloğunu seçmenize olanak tanır (tek bir API anahtarı her ikisini de kapsar).
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 olarak yazılır. Barındırılan varsayılan değer MiniMax-M3; API anahtarı kurulumu
minimax/..., OAuth kurulumu ise minimax-portal/... kullanır.
Daha fazla ayrıntı: MiniMax.
StepFun
Yapılandırma, Çin veya küresel uç noktalardaki standart StepFun ya da Step Plan için otomatik olarak 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 birlikte OLLAMA_API_KEY kullanır.
Ana makine destekli modlar temel URL'yi (varsayılan http://127.0.0.1:11434) ister, kullanılabilir modelleri keşfeder ve varsayılanlar önerir.
Cloud + Local, söz konusu Ollama ana makinesinde bulut erişimi için oturum açılıp açılmadığını da denetler.
Daha fazla ayrıntı: Ollama.
Moonshot ve Kimi Coding
Moonshot (Kimi K2) ve Kimi Coding yapılandırmaları otomatik olarak yazılır. Daha fazla ayrıntı: Moonshot AI (Kimi + Kimi Coding).
Özel sağlayıcı
OpenAI uyumlu, OpenAI Responses 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ı saklama seçeneklerini destekler:
- API anahtarını şimdi yapıştır (düz metin)
- Gizli değer başvurusu kullan (ön kontrol doğrulamasıyla ortam değişkeni başvurusu veya yapılandırılmış sağlayıcı başvurusu)
İlk katılım, yaygın görüntü modeli kimlikleri (GPT-4o/4.1/5.x, Claude 3/4, Gemini, Qwen-VL, LLaVA, Pixtral ve benzerleri) için görüntü desteğini çıkarır ve yalnızca model adı bilinmiyorsa sorar.
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 girdi yeteneğini 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ıyı ve modeli elle girin.
- İlk katılım bir sağlayıcı kimlik doğrulama seçimiyle başladığında model seçici,
söz konusu sağlayıcıyı otomatik olarak tercih eder. Volcengine ve BytePlus için aynı tercih,
kodlama planı çeşitleriyle de eşleşir (
volcengine-plan/*,byteplus-plan/*). - Tercih edilen sağlayıcı filtresi boş sonuç verecekse 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 saklama modu:
- Varsayılan ilk katılım davranışı, API anahtarlarını kimlik doğrulama profillerinde düz metin değerleri olarak kalıcı hâle getirir.
--secret-input-mode ref, düz metin anahtar saklama 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ı + kimliğiyle yapılandırılmış sağlayıcı başvurusu (
fileveyaexec)
- ortam değişkeni başvurusu (örneğin
- Etkileşimli başvuru modu, kaydetmeden önce hızlı bir ön kontrol doğrulaması çalıştırır.
- Ortam değişkeni başvuruları: geçerli ilk katılım ortamında değişken adını ve değerin boş olmadığını doğrular.
- Sağlayıcı başvuruları: sağlayıcı yapılandırmasını doğrular ve istenen kimliği çözümler.
- Ön kontrol başarısız olursa ilk katılım hatayı gösterir ve yeniden denemenize olanak tanır.
- Etkileşimsiz modda
--secret-input-mode refyalnızca ortam değişkeni desteklidir.- Sağlayıcı ortam değişkenini ilk katılım işleminin ortamında ayarlayın.
- Satır içi anahtar bayrakları (örneğin
--openai-api-key), bu ortam değişkeninin ayarlanmasını gerektirir; aksi takdirde ilk katılım hemen başarısız olur. - Özel sağlayıcılarda etkileşimsiz
refmodu,models.providers.<id>.apiKeydeğerini{ source: "env", provider: "default", id: "CUSTOM_API_KEY" }olarak saklar. - Bu özel sağlayıcı durumunda
--custom-api-key,CUSTOM_API_KEYdeğerinin ayarlanmasını gerektirir; aksi takdirde ilk katılım hemen 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ç işleyiş
~/.openclaw/openclaw.json içindeki tipik alanlar:
agents.defaults.workspace--skip-bootstrapgeçirildiğindeagents.defaults.skipBootstrapagents.defaults.model/models.providers(Minimax seçildiyse)tools.profile(ayarlanmamışsa yerel ilk katılım varsayılan olarak"coding"kullanır; mevcut açık değerler korunur)gateway.*(mod, bağlama, kimlik doğrulama, Tailscale)session.dmScope(ilk katılım açık değerleri korur; aksi durumda ayarlanmamış bırakır. Böylecemainvarsayılanı, tüm kanallardaki doğrudan mesajları ajanın devamlı ana oturumunda tutar; bu, kişisel ajan varsayılanıdır. Paylaşılan veya çok kullanıcılı gelen kutuları içinper-channel-peerkullanın;openclaw security audit, çok kullanıcılı DM trafiği algıladığında yalıtım önerir)channels.telegram.botToken,channels.discord.token,channels.matrix.*,channels.signal.*,channels.imessage.*- İstemler sırasında etkinleştirdiğinizde kanal izin listeleri (Discord, iMessage, Signal, Slack, Telegram, WhatsApp); Discord ve Slack ayrıca girilen adları kimliklere çözümler
skills.install.nodeManagersetup --node-managerbayrağınpm,pnpmveyabunkabul eder.- Elle yapılandırma daha sonra yine
skills.install.nodeManager: "yarn"değerini ayarlayabilir.
wizard.lastRunAtwizard.lastRunVersionwizard.lastRunCommitwizard.lastRunCommandwizard.lastRunModewizard.securityAcknowledgedAt
openclaw agents add, agents.entries.* ve isteğe bağlı bindings dosyasını yazar.
WhatsApp kimlik bilgileri ~/.openclaw/credentials/whatsapp/<accountId>/ altında bulunur.
Etkin oturumlar ve transkriptler
~/.openclaw/agents/<agentId>/agent/openclaw-agent.sqlite içinde saklanır.
~/.openclaw/agents/<agentId>/sessions/ dizini, eski geçiş
girdileri ve arşiv/destek yapıtları için kullanılır.
Yüklü uygulama önerileri
Model erişim denetimi başarılı olduktan sonra macOS'taki klasik etkileşimli ilk katılım, macOS gizlilik izinlerini istemeden uygulama adlarını ve paket kimliklerini tarar. Resmî Plugin kataloglarında ve ClawHub'da arama yapar, ardından yapılandırılan modelden hatalı ad eşleşmelerini reddetmesini ve ilgili Plugin'leri veya Skills'i önermesini ister. Önerilen eşleşmeler varsayılan olarak seçilir; isteğe bağlı eşleşmeler açıkça seçilmelidir.
Sonuç ekranı algılanan uygulamaları listeler ve şunu gösterir: "Uygulama adları, yapılandırdığınız model ve ClawHub araması kullanılarak eşleştirildi." Hem bu ilk katılım adımını hem de Gateway'in Node uygulama envanterlerine erişimini devre dışı bırakmak için wizard.appRecommendations değerini false olarak ayarlayın. Tarama, hızlı başlangıçta veya macOS dışındaki ilk katılımda kullanılmaz.
Etkileşimsiz kurulum
--non-interactive, --accept-risk gerektirir (ajanların
güçlü olduğunu ve tam sistem erişiminin riskli olduğunu kabul eder):
openclaw onboard --non-interactive --accept-risk \ --auth-choice apiKey \ --anthropic-api-key "$ANTHROPIC_API_KEY"Tam bayrak başvurusu ve sağlayıcıya özgü örnekler: openclaw onboard, CLI otomasyonu.
Gateway sihirbazı RPC'si
wizard.startwizard.nextwizard.cancelwizard.status
İstemciler (macOS uygulaması ve Control UI), ilk katılım mantığını yeniden uygulamadan adımları işleyebilir.
Signal kurulum davranışı
- Uygun sürüm varlığını resmî
signal-cliGitHub sürümlerinden indirir (yerel derleme, yalnızca Linux x86-64) - Diğer platformlarda (macOS, x64 olmayan Linux) bunun yerine Homebrew aracılığıyla kurar
- Sürüm varlığı kurulumunu
~/.openclaw/tools/signal-cli/<version>/altında saklar - Yapılandırmaya
kind: "managed-native"ile birliktechannels.signal.transport.cliPathyazar - Yerel Windows henüz desteklenmemektedir; Linux kurulum yolunu edinmek için ilk katılımı WSL2 içinde çalıştırın
İlgili belgeler
- İlk katılım merkezi: İlk katılım (CLI)
- Otomasyon ve betikler: CLI Otomasyonu
- Komut başvurusu:
openclaw onboard