CLI commands

İlk Kurulum

openclaw onboard

Yerel veya uzak Gateway kurulumu için etkileşimli başlangıç yapılandırması.

İlgili kılavuzlar

Örnekler

openclaw onboard
openclaw onboard --modern
openclaw onboard --flow quickstart
openclaw onboard --flow manual
openclaw onboard --flow import
openclaw onboard --import-from hermes --import-source ~/.hermes
openclaw onboard --skip-bootstrap
openclaw onboard --mode remote --remote-url wss://gateway-host:18789

--flow import, Hermes gibi Plugin tarafından sahip olunan taşıma sağlayıcılarını kullanır. Yalnızca yeni bir OpenClaw kurulumunda çalışır; mevcut yapılandırma, kimlik bilgileri, oturumlar veya çalışma alanı bellek/kimlik dosyaları varsa içe aktarmadan önce sıfırlayın veya yeni bir kurulum seçin.

--modern, Crestodian konuşmaya dayalı başlangıç yapılandırması önizlemesini başlatır. --modern olmadan, openclaw onboard klasik başlangıç yapılandırma akışını korur.

Düz metin özel ağ ws:// hedefleri için (yalnızca güvenilir ağlar), başlangıç yapılandırma süreci ortamında OPENCLAW_ALLOW_INSECURE_PRIVATE_WS=1 ayarlayın. Bu istemci tarafı taşıma acil durum geçişi için openclaw.json eşdeğeri yoktur.

Etkileşimsiz özel sağlayıcı:

openclaw onboard --non-interactive \
  --auth-choice custom-api-key \
  --custom-base-url "https://llm.example.com/v1" \
  --custom-model-id "foo-large" \
  --custom-api-key "$CUSTOM_API_KEY" \
  --secret-input-mode plaintext \
  --custom-compatibility openai \
  --custom-image-input

--custom-api-key, etkileşimsiz modda isteğe bağlıdır. Atlanırsa başlangıç yapılandırması CUSTOM_API_KEY değerini denetler. OpenClaw, yaygın görüntü model kimliklerini otomatik olarak görüntü destekli olarak işaretler. Bilinmeyen özel görüntü kimlikleri için --custom-image-input iletin veya yalnızca metin meta verilerini zorlamak için --custom-text-input kullanın.

LM Studio, etkileşimsiz modda sağlayıcıya özgü bir anahtar bayrağını da destekler:

openclaw onboard --non-interactive \
  --auth-choice lmstudio \
  --custom-base-url "http://localhost:1234/v1" \
  --custom-model-id "qwen/qwen3.5-9b" \
  --lmstudio-api-key "$LM_API_TOKEN" \
  --accept-risk

Etkileşimsiz Ollama:

openclaw onboard --non-interactive \
  --auth-choice ollama \
  --custom-base-url "http://ollama-host:11434" \
  --custom-model-id "qwen3.5:27b" \
  --accept-risk

--custom-base-url varsayılan olarak http://127.0.0.1:11434 olur. --custom-model-id isteğe bağlıdır; atlanırsa başlangıç yapılandırması Ollama'nın önerilen varsayılanlarını kullanır. kimi-k2.5:cloud gibi bulut model kimlikleri de burada çalışır.

Sağlayıcı anahtarlarını düz metin yerine ref olarak saklayın:

openclaw onboard --non-interactive \
  --auth-choice openai-api-key \
  --secret-input-mode ref \
  --accept-risk

--secret-input-mode ref ile başlangıç yapılandırması, düz metin anahtar değerleri yerine ortam destekli ref'ler yazar. Kimlik doğrulama profili destekli sağlayıcılar için bu, keyRef girdileri yazar; özel sağlayıcılar için models.providers.<id>.apiKey değerini bir ortam ref'i olarak yazar (örneğin { source: "env", provider: "default", id: "CUSTOM_API_KEY" }).

Etkileşimsiz ref modu sözleşmesi:

  • Sağlayıcı ortam değişkenini başlangıç yapılandırma süreci ortamında ayarlayın (örneğin OPENAI_API_KEY).
  • Bu ortam değişkeni de ayarlı değilse satır içi anahtar bayrakları (örneğin --openai-api-key) geçirmeyin.
  • Gerekli ortam değişkeni olmadan satır içi anahtar bayrağı geçirilirse başlangıç yapılandırması rehberlikle hızlıca başarısız olur.

Etkileşimsiz modda Gateway belirteci seçenekleri:

  • --gateway-auth token --gateway-token <token> düz metin belirteç saklar.
  • --gateway-auth token --gateway-token-ref-env <name> gateway.auth.token değerini bir ortam SecretRef'i olarak saklar.
  • --gateway-token ve --gateway-token-ref-env birlikte kullanılamaz.
  • --gateway-token-ref-env, başlangıç yapılandırma süreci ortamında boş olmayan bir ortam değişkeni gerektirir.
  • --install-daemon ile, belirteç kimlik doğrulaması bir belirteç gerektirdiğinde, SecretRef tarafından yönetilen gateway belirteçleri doğrulanır ancak denetleyici hizmet ortamı meta verilerinde çözümlenmiş düz metin olarak kalıcılaştırılmaz.
  • --install-daemon ile, belirteç modu bir belirteç gerektiriyorsa ve yapılandırılmış belirteç SecretRef'i çözümlenemiyorsa başlangıç yapılandırması düzeltme rehberliğiyle kapalı şekilde başarısız olur.
  • --install-daemon ile, hem gateway.auth.token hem de gateway.auth.password yapılandırılmışsa ve gateway.auth.mode ayarlı değilse başlangıç yapılandırması, mod açıkça ayarlanana kadar kurulumu engeller.
  • Yerel başlangıç yapılandırması yapılandırmaya gateway.mode="local" yazar. Daha sonraki bir yapılandırma dosyasında gateway.mode eksikse bunu geçerli bir yerel mod kısayolu olarak değil, yapılandırma hasarı veya eksik bir manuel düzenleme olarak değerlendirin.
  • Yerel başlangıç yapılandırması, seçilen kurulum yolu gerektirdiğinde seçili indirilebilir plugin'leri kurar.
  • Uzak başlangıç yapılandırması yalnızca uzak Gateway için bağlantı bilgilerini yazar ve yerel Plugin paketlerini kurmaz.
  • --allow-unconfigured ayrı bir gateway çalışma zamanı kaçış yoludur. Bu, başlangıç yapılandırmasının gateway.mode değerini atlayabileceği anlamına gelmez.

Örnek:

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 \
  --accept-risk

Etkileşimsiz yerel gateway sağlık denetimi:

  • --skip-health geçirmediğiniz sürece, başlangıç yapılandırması başarıyla çıkmadan önce erişilebilir bir yerel gateway bekler.
  • --install-daemon önce yönetilen gateway kurulum yolunu başlatır. Bu olmadan, örneğin openclaw gateway run ile çalışan bir yerel gateway'inizin zaten olması gerekir.
  • Otomasyonda yalnızca yapılandırma/çalışma alanı/bootstrap yazımları istiyorsanız --skip-health kullanın.
  • Çalışma alanı dosyalarını kendiniz yönetiyorsanız agents.defaults.skipBootstrap: true ayarlamak ve AGENTS.md, SOUL.md, TOOLS.md, IDENTITY.md, USER.md, HEARTBEAT.md ve BOOTSTRAP.md oluşturmayı atlamak için --skip-bootstrap geçirin.
  • Yerel Windows'ta --install-daemon önce Scheduled Tasks'ı dener ve görev oluşturma reddedilirse kullanıcı başına Startup klasörü oturum açma öğesine geri döner.

Referans moduyla etkileşimli başlangıç yapılandırması davranışı:

  • İstendiğinde Gizli referans kullan seçeneğini seçin.
  • Ardından şunlardan birini seçin:
    • Ortam değişkeni
    • Yapılandırılmış gizli sağlayıcı (file veya exec)
  • Başlangıç yapılandırması, ref'i kaydetmeden önce hızlı bir ön doğrulama gerçekleştirir.
    • Doğrulama başarısız olursa başlangıç yapılandırması hatayı gösterir ve yeniden denemenize izin verir.

Etkileşimsiz Z.AI uç nokta seçenekleri

# İstemsiz uç nokta seçimi
openclaw onboard --non-interactive \
  --auth-choice zai-coding-global \
  --zai-api-key "$ZAI_API_KEY"

# Diğer Z.AI uç nokta seçenekleri:
# --auth-choice zai-coding-cn
# --auth-choice zai-global
# --auth-choice zai-cn

Etkileşimsiz Mistral örneği:

openclaw onboard --non-interactive \
  --auth-choice mistral-api-key \
  --mistral-api-key "$MISTRAL_API_KEY"

Akış notları

Flow types
  • quickstart: en az istem, otomatik olarak bir gateway belirteci oluşturur.
  • manual: bağlantı noktası, bind ve kimlik doğrulama için tam istemler (advanced takma adı).
  • import: algılanan bir taşıma sağlayıcısını çalıştırır, planı önizler, ardından onaydan sonra uygular.
Provider prefiltering

Bir kimlik doğrulama seçeneği tercih edilen bir sağlayıcı ima ettiğinde, başlangıç yapılandırması varsayılan model ve izin listesi seçicilerini bu sağlayıcıya göre önceden filtreler. Volcengine ve BytePlus için bu, coding-plan varyantlarıyla da eşleşir (volcengine-plan/*, byteplus-plan/*).

Tercih edilen sağlayıcı filtresi henüz yüklü model üretmezse başlangıç yapılandırması seçiciyi boş bırakmak yerine filtrelenmemiş kataloğa geri döner.

Web-search follow-ups

Bazı web arama sağlayıcıları sağlayıcıya özgü takip istemlerini tetikler:

  • Grok, aynı XAI_API_KEY ve bir x_search model seçimiyle isteğe bağlı x_search kurulumu sunabilir.
  • Kimi, Moonshot API bölgesini (api.moonshot.ai veya api.moonshot.cn) ve varsayılan Kimi web arama modelini sorabilir.
Other behaviors
  • Yerel başlangıç yapılandırması DM kapsamı davranışı: CLI kurulum referansı.
  • En hızlı ilk sohbet: openclaw dashboard (Control UI, kanal kurulumu yok).
  • Özel sağlayıcı: listelenmeyen barındırılan sağlayıcılar dahil olmak üzere OpenAI veya Anthropic uyumlu herhangi bir uç noktaya bağlanın. Otomatik algılama için Unknown kullanın.
  • Hermes durumu algılanırsa başlangıç yapılandırması bir taşıma akışı sunar. Deneme çalıştırma planları, üzerine yazma modu, raporlar ve kesin eşlemeler için Taşı kullanın.

Yaygın takip komutları

openclaw configure
openclaw agents add <name>