CLI commands
Dokumentacja CLI
openclaw jest głównym punktem wejścia CLI. Każde podstawowe polecenie ma osobną
stronę referencyjną lub jest udokumentowane wraz z poleceniem, którego jest aliasem; ten indeks zawiera
polecenia, flagi globalne oraz reguły formatowania danych wyjściowych obowiązujące w całym CLI.
Polecenia konfiguracji według przeznaczenia:
openclaw setupiopenclaw onboardnajpierw weryfikują wnioskowanie, a następnie uruchamiają Crestodian w celu skonfigurowania Gateway, obszaru roboczego, kanałów, Skills i kontroli kondycji.openclaw setup --baselinetworzy konfigurację bazową i obszar roboczy bez przechodzenia przez proces konfiguracji z przewodnikiem.openclaw configurezmienia wybrane części istniejącej konfiguracji: uwierzytelnianie modelu, Gateway, kanały, pluginy lub Skills.openclaw channels addkonfiguruje konta kanałów po utworzeniu konfiguracji bazowej; uruchom bez flag, aby przejść przez konfigurację z przewodnikiem, albo z flagami specyficznymi dla kanału na potrzeby skryptów.
Strony poleceń
| Obszar | Polecenia |
|---|---|
| Konfiguracja i wdrażanie | crestodian · setup · onboard · configure · config · completion · doctor · dashboard |
| Resetowanie, kopie zapasowe i migracja | backup · migrate · reset · uninstall · update |
| Wiadomości i agenci | message · agent · agents · attach · acp · mcp |
| Kondycja i sesje | status · health · sessions · audit |
| Gateway i dzienniki | gateway · logs · system |
| Modele i wnioskowanie | models · promos · infer · capability (alias polecenia infer) · memory · commitments · wiki |
| Sieć i węzły | directory · nodes · devices · node |
| Środowisko wykonawcze i piaskownica | approvals · exec-policy (zobacz approvals) · sandbox · tui · chat/terminal (aliasy polecenia tui --local) · browser |
| Automatyzacja | cron · tasks · hooks · webhooks · transcripts |
| Wykrywanie i dokumentacja | dns · docs |
| Parowanie i kanały | pairing · qr · channels |
| Bezpieczeństwo i pluginy | security · secrets · skills · plugins · proxy |
| Starsze aliasy | daemon (usługa Gateway) · clawbot (przestrzeń nazw) |
| Pluginy (opcjonalne) | path · policy · voicecall · workboard (jeśli zainstalowano) |
Flagi globalne
| Flaga | Przeznaczenie |
|---|---|
--dev |
Izoluje stan w ~/.openclaw-dev, ustawia domyślny port Gateway na 19001 i przesuwa porty pochodne |
--profile <name> |
Izoluje stan w ~/.openclaw-<name> (OPENCLAW_STATE_DIR/OPENCLAW_CONFIG_PATH) |
--container <name> |
Uruchamia CLI wewnątrz działającego kontenera Podman/Docker o nazwie <name> (domyślnie: zmienna OPENCLAW_CONTAINER) |
--log-level <level> |
Zastępuje globalny poziom dziennika dla danych wyjściowych zapisywanych do pliku i konsoli |
--no-color |
Wyłącza kolory ANSI (uwzględniane jest również NO_COLOR=1) |
--update |
Skrót polecenia openclaw update; działa zarówno dla kopii roboczych kodu źródłowego, jak i instalacji pakietów |
-V, --version, -v |
Wyświetla wersję i kończy działanie |
Tryby wyjścia
- Kolory ANSI i wskaźniki postępu są wyświetlane tylko w sesjach TTY.
- Hiperłącza OSC-8 są wyświetlane jako klikalne odnośniki tam, gdzie są obsługiwane; w przeciwnym razie CLI używa zwykłych adresów URL.
--json(oraz--plain, jeśli jest obsługiwane) wyłącza formatowanie, zapewniając czyste dane wyjściowe.- Długotrwałe polecenia wyświetlają wskaźnik postępu (OSC 9;4, jeśli jest obsługiwany).
Paleta kolorów
OpenClaw używa palety homarowej w danych wyjściowych CLI:
| Token | Wartość szesnastkowa | Zastosowanie |
|---|---|---|
accent |
#FF5A2D |
Nagłówki, etykiety, główne wyróżnienia |
accentBright |
#FF7A3D |
Nazwy poleceń, podkreślenia |
accentDim |
#D14A22 |
Tekst wyróżnienia drugorzędnego |
info |
#FF8A5B |
Wartości informacyjne |
success |
#2FBF71 |
Stany powodzenia |
warn |
#FFB020 |
Ostrzeżenia, flagi opcji, mechanizmy rezerwowe |
error |
#E23D2D |
Błędy, niepowodzenia |
muted |
#8B7F77 |
Osłabione wyróżnienie, metadane |
Źródło prawdy dla palety: packages/terminal-core/src/palette.ts.
Drzewo poleceń
Pełne drzewo poleceń
Ta mapa obejmuje podstawowe polecenia i ich główne podpolecenia. Podpolecenia dodawane przez pluginy
(na przykład w ramach skills, plugins i wiki) rozwijają się
niezależnie; uruchom <command> --help, aby uzyskać miarodajną, aktualną listę.
openclaw [--dev] [--profile <name>] <command>crestodiansetuponboardconfigureconfig get set unset file schema validatecompletiondoctordashboardbackup create verifymigrate list plan <provider> apply <provider>security auditsecrets reload audit configure applyresetuninstallupdate wizard status repairchannels list status capabilities resolve logs add remove login logoutdirectory self peers list groups list|membersskills search install update verify workshop list|inspect|propose-create|propose-update|revise|apply|reject|quarantine list info checkplugins list search inspect install uninstall update enable disable doctor build validate init registry marketplace list|entries|refreshworkboard list create show dispatchmemory status index searchtranscripts list show pathpath resolve find set validate emitcommitments list dismisswiki status doctor init compile lint ingest okf import search get apply synthesis|metadata bridge import unsafe-local import chatgpt import|rollback obsidian status|search|open|command|dailymessage send broadcast poll react reactions read edit delete pin unpin pins permissions search thread create|list|reply emoji list|upload sticker send|upload role info|add|remove channel info|list member info voice status event list|create timeout kick banagentagents list add delete bindings bind unbind set-identityattachacpmcp serve list show set unsetstatushealthsessions cleanupaudittasks list audit maintenance show notify cancel flow list|show|cancelgateway call usage-cost health stability diagnostics export status probe discover install uninstall start stop restart rundaemon status install uninstall start stop restartlogssystem event heartbeat last|enable|disable presencemodels list status set set-image aliases list|add|remove fallbacks list|add|remove|clear image-fallbacks list|add|remove|clear scan auth list|add|login|setup-token|paste-token|paste-api-key|login-github-copilot auth order get|set|clearpromos list claim <slug>infer (alias: capability) list inspect model run|list|inspect|providers|auth login|logout|status image generate|edit|describe|describe-many|providers audio transcribe|providers tts convert|voices|personas|providers|status|enable|disable|set-provider|set-persona video generate|describe|providers web search|fetch|providers embedding create|providerssandbox list recreate explaincron status list get add edit rm enable disable runs runnodes status describe list pending approve reject rename invoke notify push canvas snapshot|present|hide|navigate|eval canvas a2ui push|reset camera list|snap|clip screen record location getdevices list remove clear approve reject rotate revokenode run status install uninstall stop restartapprovals get set allowlist add|removeexec-policy show preset setbrowser status start stop reset-profile tabs open focus close profiles create-profile delete-profile screenshot snapshot navigate resize click type press hover drag select upload fill dialog wait evaluate console pdfhooks list info check enable disable install updatewebhooks gmail setup|runproxy start run coverage sessions query blob purgepairing list approveqrclawbot qrdocsdns setuptuichat (alias: tui --local)terminal (alias: tui --local)Pluginy mogą dodawać dodatkowe polecenia najwyższego poziomu, takie jak
openclaw workboard lub openclaw voicecall.
Polecenia ukośnikowe na czacie
Wiadomości na czacie obsługują polecenia /.... Zobacz polecenia ukośnikowe.
Najważniejsze:
/status— szybka diagnostyka./trace— wiersze śledzenia/debugowania Pluginu ograniczone do sesji./config— trwałe zmiany konfiguracji./debug— nadpisania konfiguracji tylko w czasie działania (w pamięci, nie na dysku; wymagacommands.debug: true).
Śledzenie użycia
Polecenie openclaw status --usage oraz interfejs sterowania wyświetlają użycie i limity dostawcy, gdy
dostępne są dane uwierzytelniające OAuth/API. Dane pochodzą bezpośrednio z punktów końcowych
dostawców dotyczących użycia i są normalizowane do postaci X% left. Dostawcy udostępniający bieżące
okna użycia: Anthropic, Gemini CLI, GitHub Copilot, MiniMax, OpenAI Codex,
Xiaomi oraz z.ai.
Szczegółowe informacje zawiera sekcja Śledzenie użycia.