CLI commands
CLI-referentie
openclaw is het belangrijkste CLI-toegangspunt. Elke kernopdracht heeft een eigen
referentiepagina of wordt gedocumenteerd bij de opdracht waarvoor deze een alias is; deze index bevat
de opdrachten, globale vlaggen en regels voor uitvoeropmaak die voor de hele CLI gelden.
Installatieopdrachten per doel:
openclaw setupenopenclaw onboardverifiëren eerst de inferentie en starten vervolgens Crestodian voor de configuratie van de Gateway, werkruimte, kanalen, Skills en statuscontroles.openclaw setup --baselinemaakt de basisconfiguratie en werkruimte zonder de begeleide onboarding te doorlopen.openclaw configurewijzigt specifieke onderdelen van een bestaande installatie: modelauthenticatie, Gateway, kanalen, Plugins of Skills.openclaw channels addconfigureert kanaalaccounts nadat de basisconfiguratie bestaat; voer de opdracht zonder vlaggen uit voor begeleide configuratie of met kanaalspecifieke vlaggen voor scripts.
Opdrachtpagina's
| Gebied | Opdrachten |
|---|---|
| Installatie en onboarding | crestodian · setup · onboard · configure · config · completion · doctor · dashboard |
| Herstel, back-up en migratie | backup · migrate · reset · uninstall · update |
| Berichten en agents | message · agent · agents · attach · acp · mcp |
| Status en sessies | status · health · sessions · audit |
| Gateway en logboeken | gateway · logs · system |
| Modellen en inferentie | models · promos · infer · capability (alias voor infer) · memory · commitments · wiki |
| Netwerk en Nodes | directory · nodes · devices · node |
| Runtime en sandbox | approvals · exec-policy (zie approvals) · sandbox · tui · chat/terminal (aliassen voor tui --local) · browser |
| Automatisering | cron · tasks · hooks · webhooks · transcripts |
| Detectie en documentatie | dns · docs |
| Koppeling en kanalen | pairing · qr · channels |
| Beveiliging en Plugins | security · secrets · skills · plugins · proxy |
| Verouderde aliassen | daemon (Gateway-service) · clawbot (naamruimte) |
| Plugins (optioneel) | path · policy · voicecall · workboard (indien geïnstalleerd) |
Globale vlaggen
| Vlag | Doel |
|---|---|
--dev |
Isoleert de status onder ~/.openclaw-dev, gebruikt standaard Gateway-poort 19001 en verschuift afgeleide poorten |
--profile <name> |
Isoleert de status onder ~/.openclaw-<name> (OPENCLAW_STATE_DIR/OPENCLAW_CONFIG_PATH) |
--container <name> |
Voert de CLI uit in een actieve Podman-/Docker-container met de naam <name> (standaard: env OPENCLAW_CONTAINER) |
--log-level <level> |
Overschrijft het globale logniveau voor uitvoer naar bestanden en de console |
--no-color |
Schakelt ANSI-kleuren uit (NO_COLOR=1 wordt ook gerespecteerd) |
--update |
Verkorte vorm van openclaw update; werkt voor zowel broncodecheck-outs als pakketinstallaties |
-V, --version, -v |
Toont de versie en sluit af |
Uitvoermodi
- ANSI-kleuren en voortgangsindicatoren worden alleen in TTY-sessies weergegeven.
- OSC-8-hyperlinks worden waar ondersteund als klikbare koppelingen weergegeven; anders valt de CLI terug op gewone URL's.
--json(en--plainwaar ondersteund) schakelt opmaak uit voor overzichtelijke uitvoer.- Langlopende opdrachten tonen een voortgangsindicator (OSC 9;4 waar ondersteund).
Kleurenpalet
OpenClaw gebruikt een kreeftenpalet voor CLI-uitvoer:
| Token | Hex | Gebruikt voor |
|---|---|---|
accent |
#FF5A2D |
Koppen, labels, primaire markeringen |
accentBright |
#FF7A3D |
Opdrachtnamen, nadruk |
accentDim |
#D14A22 |
Secundaire markeringstekst |
info |
#FF8A5B |
Informatieve waarden |
success |
#2FBF71 |
Geslaagde statussen |
warn |
#FFB020 |
Waarschuwingen, optievlaggen, terugvalpaden |
error |
#E23D2D |
Fouten, mislukkingen |
muted |
#8B7F77 |
Minder nadruk, metagegevens |
Gezaghebbende bron voor het palet: packages/terminal-core/src/palette.ts.
Opdrachtstructuur
Volledige opdrachtstructuur
Dit overzicht omvat de kernopdrachten en hun belangrijkste subopdrachten. Door Plugins toegevoegde
subopdrachten (bijvoorbeeld onder skills, plugins en wiki) ontwikkelen zich
onafhankelijk; voer <command> --help uit voor de gezaghebbende, actuele lijst.
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)Plugins kunnen aanvullende opdrachten op het hoogste niveau toevoegen, zoals
openclaw workboard of openclaw voicecall.
Slash-opdrachten in chats
Chatberichten ondersteunen /...-opdrachten. Zie slash-opdrachten.
Belangrijkste opdrachten:
/status- snelle diagnostiek./trace- sessiegebonden traceer- en foutopsporingsregels van Plugins./config- blijvende configuratiewijzigingen./debug- configuratieoverschrijvingen uitsluitend tijdens runtime (in het geheugen, niet op schijf; vereistcommands.debug: true).
Gebruiksregistratie
openclaw status --usage en de Control UI tonen het gebruik en quotum van providers wanneer
OAuth-/API-referenties beschikbaar zijn. De gegevens zijn rechtstreeks afkomstig van de
gebruikseindpunten van providers en worden genormaliseerd naar X% left. Providers met actuele
gebruiksvensters: Anthropic, Gemini CLI, GitHub Copilot, MiniMax, OpenAI Codex,
Xiaomi en z.ai.
Zie Gebruiksregistratie voor meer informatie.