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) prowadzi przez:

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

Tryb zdalny konfiguruje tę maszynę do łączenia się z Gateway 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 Gateway w innym miejscu.

Co ustawiasz:

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

# Opcje uwierzytelniania i modeli

Zachowanie modelu:

• Wybierz domyślny model z wykrytych opcji albo ręcznie wpisz dostawcę i model.
• Onboarding niestandardowego dostawcy 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 kodowania (volcengine-plan/*, byteplus-plan/*).
• Jeśli ten filtr preferowanego dostawcy byłby pusty, selektor wraca do pełnego katalogu zamiast nie pokazywać żadnych modeli.
• Kreator wykonuje 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 utrwala klucze API jako wartości w postaci jawnej w profilach uwierzytelniania.
• --secret-input-mode ref włącza tryb odniesień zamiast przechowywania kluczy w postaci jawnej. W konfiguracji interaktywnej możesz wybrać:
  • odniesienie do zmiennej środowiskowej (na przykład keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • skonfigurowane odniesienie dostawcy (file albo exec) z aliasem dostawcy + id
• Interaktywny tryb odniesień uruchamia szybką walidację wstępną przed zapisaniem.
  • Odniesienia env: waliduje nazwę zmiennej + niepustą wartość w bieżącym środowisku onboardingu.
  • Odniesienia dostawcy: waliduje konfigurację dostawcy i rozwiązuje żądane id.
  • Jeśli walidacja wstępna się nie powiedzie, onboarding pokazuje błąd i pozwala spróbować ponownie.
• 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 kończy się błędem.
  • Dla 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ą wybory postaci jawnej i SecretRef w konfiguracji interaktywnej:
  • Tryb tokena: Wygeneruj/zapisz token w postaci jawnej (domyślnie) albo Użyj SecretRef.
  • Tryb hasła: postać jawna albo SecretRef.
• Nieinteraktywna ścieżka SecretRef dla tokena: --gateway-token-ref-env <ENV_VAR>.
• Istniejące konfiguracje w postaci jawnej 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 (lokalne wdrażanie domyślnie używa "coding", gdy nie ustawiono wartości; istniejące jawne wartości są zachowywane)
• gateway.* (tryb, powiązanie, uwierzytelnianie, tailscale)
• session.dmScope (lokalne wdrażanie domyślnie ustawia to na per-channel-peer, gdy nie ustawiono wartości; 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 lub bun.
  • Ręczna konfiguracja nadal może później 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 Control UI) mogą renderować kroki bez ponownej implementacji logiki wdrażania.

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ązane dokumenty

• Centrum wdrażania: Wdrażanie (CLI)
• Automatyzacja i skrypty: Automatyzacja CLI
• Dokumentacja polecenia: openclaw onboard