​

Referencja konfiguracji CLI

Ta strona zawiera pełną referencję 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, 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, bind, auth, tailscale)
• Kanały i dostawców (Telegram, WhatsApp, Discord, Google Chat, Mattermost, Signal, BlueBubbles i inne dołączone wtyczki kanałów)
• Instalację daemon (LaunchAgent, jednostka użytkownika systemd lub natywne zadanie Windows Scheduled Task z awaryjnym fallbackiem do folderu Startup)
• Kontrolę stanu zdrowia
• Konfigurację Skills

Tryb zdalny konfiguruje tę maszynę tak, aby łączyła się z gateway uruchomionym gdzie indziej. Nie instaluje ani nie modyfikuje niczego na hoście zdalnym.

​

Szczegóły przepływu lokalnego

​

Szczegóły trybu zdalnego

Tryb zdalny konfiguruje tę maszynę tak, aby łączyła się z gateway uruchomionym gdzie indziej. Co ustawiasz:

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

​

Opcje uwierzytelniania i modeli

Zachowanie modelu:

• Wybierz model domyślny z wykrytych opcji albo wprowadź dostawcę i model ręcznie.
• Gdy onboarding zaczyna się od wyboru uwierzytelniania dostawcy, selektor modelu automatycznie preferuje tego dostawcę. Dla Volcengine i BytePlus ta sama preferencja dopasowuje również ich warianty planu kodowania (volcengine-plan/*, byteplus-plan/*).
• Jeśli taki filtr preferowanego dostawcy byłby pusty, selektor wraca do pełnego katalogu zamiast pokazywać brak modeli.
• Kreator wykonuje kontrolę modelu i ostrzega, jeśli skonfigurowany model jest nieznany lub brakuje auth.

Ścieżki poświadczeń i profili:

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

Tryb przechowywania poświadczeń:

• Domyślne zachowanie onboardingu zapisuje klucze API jako wartości jawne w profilach auth.
• --secret-input-mode ref włącza tryb referencyjny zamiast przechowywania klucza jako tekst jawny. W konfiguracji interaktywnej możesz wybrać jedno z poniższych:
  • referencja do zmiennej środowiskowej (na przykład keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • skonfigurowana referencja dostawcy (file lub exec) z aliasem dostawcy + ID
• Interaktywny tryb referencyjny wykonuje szybką walidację preflight przed zapisaniem.
  • Referencje środowiskowe: weryfikuje nazwę zmiennej + niepustą wartość w bieżącym środowisku onboardingu.
  • Referencje dostawcy: weryfikuje konfigurację dostawcy i rozwiązuje żądane ID.
  • Jeśli preflight się nie powiedzie, onboarding pokazuje błąd i pozwala spróbować ponownie.
• W trybie nieinteraktywnym --secret-input-mode ref jest obsługiwany tylko dla środowiska.
  • Ustaw zmienną środowiskową dostawcy w środowisku procesu onboardingu.
  • Flagi z kluczem inline (na przykład --openai-api-key) wymagają ustawienia tej zmiennej środowiskowej; w przeciwnym razie onboarding kończy się szybkim 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 kończy się szybkim błędem.
• Poświadczenia auth gateway obsługują w konfiguracji interaktywnej wybór tekstu jawnego i SecretRef:
  • Tryb tokena: Generate/store plaintext token (domyślnie) lub Use SecretRef.
  • Tryb hasła: tekst jawny lub SecretRef.
• Ścieżka SecretRef dla tokena w trybie nieinteraktywnym: --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.model / models.providers (jeśli wybrano Minimax)
• tools.profile (lokalny onboarding domyślnie ustawia "coding", jeśli wartość nie jest ustawiona; istniejące jawne wartości są zachowywane)
• gateway.* (mode, bind, auth, tailscale)
• session.dmScope (lokalny onboarding domyślnie ustawia per-channel-peer, jeśli wartość nie jest ustawiona; istniejące jawne wartości są zachowywane)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Allowlisty kanałów (Slack, Discord, Matrix, Microsoft Teams), jeśli włączysz je podczas promptów (nazwy są rozwiązywane do ID, gdy to możliwe)
• skills.install.nodeManager
  • Flaga setup --node-manager akceptuje npm, pnpm lub bun.
  • Ręczna konfiguracja może nadal później ustawić skills.install.nodeManager: "yarn".
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode

openclaw agents add zapisuje agents.list[] oraz opcjonalne bindings. Poświadczenia 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
• Buildy JVM wymagają Java 21
• Jeśli są dostępne, używane są buildy natywne
• Windows używa WSL2 i postępuje zgodnie z przepływem Linux signal-cli wewnątrz WSL

​

Powiązane dokumenty

• Hub onboardingu: Onboarding (CLI)
• Automatyzacja i skrypty: Automatyzacja CLI
• Dokumentacja polecenia: openclaw onboard