Dokumentacja referencyjna konfiguracji CLI

Ta strona jest pełną dokumentacją referencyjną dla openclaw onboard. Krótki przewodnik znajdziesz w Onboarding (CLI).

Co robi kreator

Tryb lokalny (domyślny) przeprowadza Cię 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 startowe
• Ustawienia Gateway (port, bind, uwierzytelnianie, tailscale)
• Kanały i dostawców (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, iMessage i inne dołączone Plugin kanałów)
• Instalację demona (LaunchAgent, jednostka użytkownika systemd albo natywne Windows Scheduled Task z rezerwowym użyciem folderu Autostart)
• Kontrolę kondycji
• Konfigurację Skills

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

Szczegóły przepływu lokalnego

Szczegóły trybu zdalnego

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

Co ustawiasz:

• URL zdalnego gatewaya (ws://...)
• Token, jeśli wymagane jest uwierzytelnianie zdalnego gatewaya (zalecane)

Opcje uwierzytelniania i modeli

Zachowanie modelu:

• Wybierz domyślny model z wykrytych opcji albo wprowadź dostawcę i model ręcznie.
• Onboarding dostawcy niestandardowego wnioskuje obsługę obrazów dla typowych identyfikatorów 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 dopasowuje także ich warianty planów coding (volcengine-plan/*, byteplus-plan/*).
• Jeśli filtr preferowanego dostawcy byłby pusty, selektor wraca do pełnego katalogu zamiast nie pokazywać żadnych modeli.
• Kreator uruchamia sprawdzenie modelu i ostrzega, jeśli skonfigurowany model jest nieznany albo brakuje uwierzytelniania.

Ścieżki danych uwierzytelniających i profili:

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

Tryb przechowywania danych uwierzytelniających:

• Domyślne zachowanie onboardingu zapisuje klucze API jako wartości jawnego tekstu w profilach uwierzytelniania.
• --secret-input-mode ref włącza tryb odwołań zamiast przechowywania kluczy w postaci jawnego tekstu. W konfiguracji interaktywnej możesz wybrać:
  • odwołanie do zmiennej środowiskowej (na przykład keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • skonfigurowany provider ref (file albo exec) z aliasem dostawcy + id
• Interaktywny tryb odwołań uruchamia szybką walidację preflight przed zapisaniem.
  • Env refs: sprawdza nazwę zmiennej + niepustą wartość w bieżącym środowisku onboardingu.
  • Provider refs: sprawdza konfigurację dostawcy i rozwiązuje żądany id.
  • Jeśli preflight się nie powiedzie, onboarding pokazuje błąd i pozwala ponowić próbę.
• W trybie nieinteraktywnym --secret-input-mode ref jest obsługiwany tylko przez env.
  • Ustaw zmienną środowiskową dostawcy w środowisku procesu onboardingu.
  • Flagi kluczy inline (na przykład --openai-api-key) wymagają ustawienia tej zmiennej środowiskowej; w przeciwnym razie onboarding szybko zakończy się błędem.
  • Dla dostawców niestandardowych nieinteraktywny tryb ref przechowuje models.providers.<id>.apiKey jako { source: "env", provider: "default", id: "CUSTOM_API_KEY" }.
  • W tym przypadku dostawcy niestandardowego --custom-api-key wymaga ustawienia CUSTOM_API_KEY; w przeciwnym razie onboarding szybko zakończy się błędem.
• Dane uwierzytelniające Gateway obsługują wybór jawnego tekstu i SecretRef w konfiguracji interaktywnej:
  • Tryb tokenu: Wygeneruj/zapisz token w postaci jawnego tekstu (domyślnie) albo Użyj SecretRef.
  • Tryb hasła: jawny tekst albo SecretRef.
• Nieinteraktywna ścieżka SecretRef dla tokenu: --gateway-token-ref-env <ENV_VAR>.
• Istniejące konfiguracje z jawnym tekstem nadal działają bez zmian.

Dane wyjściowe 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 (lokalna konfiguracja początkowa domyślnie używa "coding", gdy pole nie jest ustawione; istniejące jawne wartości są zachowywane)
• gateway.* (mode, bind, auth, tailscale)
• session.dmScope (lokalna konfiguracja początkowa 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 może później nadal ustawić skills.install.nodeManager: "yarn".
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode

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 interfejs Control UI) mogą renderować kroki bez ponownej implementacji logiki konfiguracji początkowej.

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 stosuje linuksowy przepływ signal-cli wewnątrz WSL

Powiązana dokumentacja

• Centrum konfiguracji początkowej: Konfiguracja początkowa (CLI)
• Automatyzacja i skrypty: Automatyzacja CLI
• Dokumentacja polecenia: openclaw onboard