Dokumentacja konfiguracji CLI

Ta strona opisuje krok po kroku przebieg wdrażania, jego wyniki i mechanizmy wewnętrzne. Przewodnik znajduje się w sekcji Wdrażanie (CLI). Pełna dokumentacja flag CLI (wszystkie --flag, przykłady nieinteraktywne, polecenia specyficzne dla dostawców) znajduje się w sekcji openclaw onboard.

Działanie kreatora

Tryb lokalny (domyślny) prowadzi przez następujące etapy:

• Konfiguracja modelu i uwierzytelniania (Anthropic, OAuth subskrypcji OpenAI Code, xAI, OpenCode, niestandardowe punkty końcowe i inne przepływy uwierzytelniania należące do dostawców)
• Lokalizacja obszaru roboczego i pliki inicjalizacyjne
• Ustawienia Gateway (port, powiązanie, uwierzytelnianie, Tailscale)
• Kanały i dostawcy (Discord, Feishu, Google Chat, iMessage, Mattermost, Microsoft Teams, QQ Bot, Signal, Slack, Telegram, WhatsApp oraz inne kanały wbudowane lub udostępniane przez pluginy)
• Dostawca wyszukiwania internetowego (opcjonalnie)
• Instalacja demona (LaunchAgent, jednostka użytkownika systemd lub natywne zadanie Harmonogramu zadań systemu Windows z mechanizmem rezerwowym wykorzystującym folder Autostart)
• Kontrola stanu
• Konfiguracja Skills

Tryb zdalny konfiguruje ten komputer do łączenia się z Gateway działającym 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 ten komputer do łączenia się z Gateway działającym w innym miejscu. Nie instaluje ani nie modyfikuje niczego na zdalnym hoście.

Konfigurowane elementy:

• Adres URL zdalnego Gateway (ws://... lub wss://...)
• Token, hasło lub brak uwierzytelniania, zgodnie z konfiguracją zdalnego Gateway

Opcje uwierzytelniania i modelu

Jeśli etap konfiguracji dostawcy nie powiedzie się podczas interaktywnego wdrażania (na przykład opcja ponownego użycia CLI bez lokalnego zalogowania), kreator wyświetla błąd i wraca do wyboru dostawcy, zamiast kończyć działanie. Jawne uruchomienia --auth-choice nadal natychmiast kończą się niepowodzeniem na potrzeby automatyzacji.

Zachowanie modelu:

• Należy wybrać domyślny model spośród wykrytych opcji albo ręcznie wprowadzić dostawcę i model.
• Gdy wdrażanie rozpoczyna się od wyboru uwierzytelniania dostawcy, selektor modeli automatycznie preferuje tego dostawcę. W przypadku Volcengine i BytePlus ta sama preferencja obejmuje również ich warianty planów programistycznych (volcengine-plan/*, byteplus-plan/*).
• Jeśli filtr preferowanego dostawcy nie zwróciłby żadnych wyników, selektor używa pełnego katalogu zamiast wyświetlać brak modeli.
• Kreator przeprowadza kontrolę modelu i ostrzega, jeśli skonfigurowany model jest nieznany lub brakuje uwierzytelniania.

Ścieżki poświadczeń i profili:

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

Tryb przechowywania poświadczeń:

• Domyślne zachowanie wdrażania zapisuje klucze API jako wartości tekstu jawnego w profilach uwierzytelniania.
• --secret-input-mode ref włącza tryb odwołań zamiast przechowywania kluczy jako tekstu jawnego. W konfiguracji interaktywnej można wybrać:
  • odwołanie do zmiennej środowiskowej (na przykład keyRef: { source: "env", provider: "default", id: "OPENAI_API_KEY" })
  • odwołanie do skonfigurowanego dostawcy (file lub exec) z aliasem i identyfikatorem dostawcy
• Interaktywny tryb odwołań przeprowadza szybką wstępną walidację przed zapisaniem.
  • Odwołania do zmiennych środowiskowych: sprawdzają nazwę zmiennej i niepustą wartość w bieżącym środowisku wdrażania.
  • Odwołania do dostawców: sprawdzają konfigurację dostawcy i rozwiązują żądany identyfikator.
  • Jeśli wstępna walidacja zakończy się niepowodzeniem, wdrażanie wyświetla błąd i umożliwia ponowienie próby.
• W trybie nieinteraktywnym --secret-input-mode ref korzysta wyłącznie ze zmiennych środowiskowych.
  • Należy ustawić zmienną środowiskową dostawcy w środowisku procesu wdrażania.
  • Flagi kluczy wbudowanych (na przykład --openai-api-key) wymagają ustawienia tej zmiennej środowiskowej; w przeciwnym razie wdrażanie natychmiast kończy się niepowodzeniem.
  • W przypadku niestandardowych dostawców nieinteraktywny tryb ref przechowuje 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 wdrażanie natychmiast kończy się niepowodzeniem.
• Poświadczenia uwierzytelniania Gateway obsługują w konfiguracji interaktywnej tekst jawny i SecretRef:
  • Tryb tokenu: Wygeneruj/przechowaj token jako tekst jawny (domyślnie) lub Użyj SecretRef.
  • Tryb hasła: tekst jawny lub SecretRef.
• Nieinteraktywna ścieżka SecretRef tokenu: --gateway-token-ref-env <ENV_VAR>.
• Istniejące konfiguracje z tekstem jawnym nadal działają bez zmian.

Dane wyjściowe i mechanizmy 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 ustawia "coding", gdy wartość nie jest ustawiona; istniejące wartości jawne są zachowywane)
• gateway.* (tryb, powiązanie, uwierzytelnianie, Tailscale)
• session.dmScope (lokalne wdrażanie domyślnie ustawia tę wartość na per-channel-peer, gdy nie jest ustawiona; istniejące wartości jawne są zachowywane)
• channels.telegram.botToken, channels.discord.token, channels.matrix.*, channels.signal.*, channels.imessage.*
• Listy dozwolonych kanałów (Discord, iMessage, Signal, Slack, Telegram, WhatsApp), gdy zostaną wybrane w monitach; Discord i Slack rozwiązują również wprowadzone nazwy na identyfikatory
• skills.install.nodeManager
  • Flaga setup --node-manager przyjmuje npm, pnpm lub bun.
  • Konfiguracja ręczna może później nadal ustawić skills.install.nodeManager: "yarn".
• wizard.lastRunAt
• wizard.lastRunVersion
• wizard.lastRunCommit
• wizard.lastRunCommand
• wizard.lastRunMode
• wizard.securityAcknowledgedAt

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

Poświadczenia WhatsApp są umieszczane w ~/.openclaw/credentials/whatsapp/<accountId>/. Aktywne sesje i transkrypcje są przechowywane w ~/.openclaw/agents/<agentId>/agent/openclaw-agent.sqlite. Katalog ~/.openclaw/agents/<agentId>/sessions/ służy do przechowywania danych wejściowych starszych migracji oraz artefaktów archiwalnych i pomocy technicznej.

Konfiguracja nieinteraktywna

--non-interactive wymaga --accept-risk (potwierdza świadomość, że agenci są potężni, a pełny dostęp do systemu jest ryzykowny):

openclaw onboard --non-interactive --accept-risk \  --auth-choice apiKey \  --anthropic-api-key "$ANTHROPIC_API_KEY"

Pełna dokumentacja flag i przykłady specyficzne dla dostawców: openclaw onboard, Automatyzacja CLI.

RPC kreatora Gateway

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

Klienci (aplikacja macOS i interfejs Control UI) mogą renderować kroki bez ponownego implementowania logiki wdrażania.

Zachowanie konfiguracji Signal

• Pobiera odpowiedni zasób wydania z oficjalnych wydań GitHub signal-cli (kompilacja natywna, tylko Linux x86-64)
• Na innych platformach (macOS, Linux inny niż x64) instaluje zamiast tego przez Homebrew
• Przechowuje instalację zasobu wydania w ~/.openclaw/tools/signal-cli/<version>/
• Zapisuje channels.signal.cliPath w konfiguracji
• Natywny system Windows nie jest jeszcze obsługiwany; należy uruchomić wdrażanie wewnątrz WSL2, aby uzyskać ścieżkę instalacji systemu Linux

Powiązana dokumentacja

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