Dokumentacja konfiguracji CLI

Ta strona jest pełnym opisem referencyjnym openclaw onboard. Krótki przewodnik znajdziesz w Onboarding (CLI).

Co robi kreator

Tryb lokalny (domyślny) prowadzi przez:

• Konfigurację modelu i uwierzytelniania (OAuth subskrypcji OpenAI Code, CLI Anthropic Claude lub klucz API, a także opcje MiniMax, GLM, Ollama, Moonshot, StepFun i AI Gateway)
• Lokalizację obszaru roboczego i pliki bootstrap
• Ustawienia Gateway (port, bind, uwierzytelnianie, Tailscale)
• Kanały i dostawców (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, iMessage i inne dołączone pluginy kanałów)
• Instalację demona (LaunchAgent, jednostka użytkownika systemd albo natywne Zadanie Harmonogramu zadań Windows z mechanizmem awaryjnym folderu Autostart)
• Kontrolę stanu
• Konfigurację Skills

Tryb zdalny konfiguruje tę maszynę do łączenia się z Gateway w innym miejscu. Nie instaluje ani nie modyfikuje niczego na hoście zdalnym.

Szczegóły przepływu lokalnego

Szczegóły trybu zdalnego

Tryb zdalny konfiguruje tę maszynę do łączenia się z Gateway w innym miejscu.

Co ustawiasz:

• URL zdalnego Gateway (ws://...)
• Token, jeśli zdalny Gateway wymaga uwierzytelniania (zalecane)

Opcje uwierzytelniania i modelu

Zachowanie modelu:

• Wybierz domyślny model z wykrytych opcji albo ręcznie wprowadź dostawcę i model.
• Onboarding dostawcy niestandardowego wnioskuje obsługę obrazów dla popularnych ID modeli i pyta tylko wtedy, gdy nazwa modelu jest nieznana.
• Gdy onboarding zaczyna się od wyboru uwierzytelniania dostawcy, selektor modeli automatycznie preferuje tego dostawcę. Dla Volcengine i BytePlus ta sama preferencja pasuje także do ich wariantów planów kodowania (volcengine-plan/*, byteplus-plan/*).
• Jeśli filtr preferowanego dostawcy byłby pusty, selektor przechodzi awaryjnie do pełnego katalogu zamiast pokazywać brak modeli.
• Kreator uruchamia sprawdzenie modelu i ostrzega, jeśli skonfigurowany model jest nieznany albo brakuje uwierzytelniania.

Ścieżki poświadczeń i profili:

• Profile uwierzytelniania (klucze API + OAuth): ~/.openclaw/agents/<agentId>/agent/auth-profiles.json
• Import przestarzałego OAuth: ~/.openclaw/credentials/oauth.json

Tryb przechowywania poświadczeń:

• Domyślne zachowanie onboardingu utrwala klucze API jako wartości tekstowe w profilach uwierzytelniania.
• --secret-input-mode ref włącza tryb referencji zamiast przechowywania klucza jako tekstu jawnego. W konfiguracji interaktywnej możesz wybrać:
  • referencję do zmiennej środowiskowej (na przykład keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • skonfigurowaną referencję dostawcy (file lub exec) z aliasem dostawcy + identyfikatorem
• Interaktywny tryb referencji uruchamia szybką walidację wstępną przed zapisaniem.
  • Referencje env: sprawdzają nazwę zmiennej + niepustą wartość w bieżącym środowisku onboardingu.
  • Referencje dostawcy: sprawdzają konfigurację dostawcy i rozwiązują żądany identyfikator.
  • Jeśli walidacja wstępna się nie powiedzie, onboarding pokazuje błąd i pozwala spróbować ponownie.
• W trybie nieinteraktywnym --secret-input-mode ref korzysta wyłącznie ze zmiennych środowiskowych.
  • Ustaw zmienną środowiskową dostawcy w środowisku procesu onboardingu.
  • Flagi klucza inline (na przykład --openai-api-key) wymagają ustawienia tej zmiennej środowiskowej; w przeciwnym razie onboarding szybko kończy się błędem.
  • W przypadku niestandardowych dostawców nieinteraktywny tryb ref zapisuje models.providers.<id>.apiKey jako { source: "env", provider: "default", id: "CUSTOM_API_KEY" }.
  • W tym przypadku niestandardowego dostawcy --custom-api-key wymaga ustawienia CUSTOM_API_KEY; w przeciwnym razie onboarding szybko kończy się błędem.
• Dane uwierzytelniające Gateway obsługują wybór tekstu jawnego i SecretRef w konfiguracji interaktywnej:
  • Tryb tokena: Wygeneruj/zapisz token jako tekst jawny (domyślnie) albo Użyj SecretRef.
  • Tryb hasła: tekst jawny albo SecretRef.
• Nieinteraktywna ścieżka SecretRef tokena: --gateway-token-ref-env <ENV_VAR>.
• Istniejące konfiguracje z tekstem jawnym nadal działają bez zmian.

Wyniki i elementy wewnętrzne

Typowe pola w ~/.openclaw/openclaw.json:

• agents.defaults.workspace
• agents.defaults.skipBootstrap, gdy przekazano --skip-bootstrap
• agents.defaults.model / models.providers (jeśli wybrano Minimax)
• tools.profile (lokalny onboarding domyślnie używa "coding", gdy pole nie jest ustawione; istniejące jawne wartości są zachowywane)
• gateway.* (tryb, powiązanie, uwierzytelnianie, tailscale)
• session.dmScope (lokalny onboarding domyślnie ustawia to na per-channel-peer, gdy pole nie jest ustawione; istniejące jawne wartości są zachowywane)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Listy dozwolonych kanałów (Slack, Discord, Matrix, Microsoft Teams), gdy włączysz je podczas monitów (nazwy są rozwiązywane na identyfikatory, gdy to możliwe)
• skills.install.nodeManager
  • Flaga setup --node-manager akceptuje npm, pnpm albo bun.
  • Ręczna konfiguracja nadal może później ustawić skills.install.nodeManager: "yarn".
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode
• wizard.securityAcknowledgedAt

openclaw agents add zapisuje agents.list[] i opcjonalne bindings.

Dane uwierzytelniające WhatsApp trafiają do ~/.openclaw/credentials/whatsapp/<accountId>/. Sesje są przechowywane w ~/.openclaw/agents/<agentId>/sessions/.

RPC kreatora Gateway:

• wizard.start
• wizard.next
• wizard.cancel
• wizard.status

Klienci (aplikacja macOS i Control UI) mogą renderować kroki bez ponownej implementacji logiki onboardingu.

Zachowanie konfiguracji Signal:

• Pobiera odpowiedni zasób wydania
• Przechowuje go w ~/.openclaw/tools/signal-cli/<version>/
• Zapisuje channels.signal.cliPath w konfiguracji
• Kompilacje JVM wymagają Java 21
• Kompilacje natywne są używane, gdy są dostępne
• Windows używa WSL2 i wykonuje linuksowy przepływ signal-cli wewnątrz WSL

Powiązane dokumenty

• Centrum onboardingu: Onboarding (CLI)
• Automatyzacja i skrypty: Automatyzacja CLI
• Odniesienie polecenia: openclaw onboard