CLI-referentie
Deze pagina beschrijft het huidige CLI-gedrag. Als opdrachten veranderen, werk dit document bij.Opdrachtpagina’s
setuponboardconfigureconfigdoctordashboardresetuninstallupdatemessageagentagentsacpstatushealthsessionsgatewaylogssystemmodelsmemorynodesdevicesnodeapprovalssandboxtuibrowsercrondnsdocshookswebhookspairingplugins(plugin-opdrachten)channelssecurityskillsvoicecall(plugin; indien geïnstalleerd)
Globale flags
--dev: isoleer status onder~/.openclaw-deven verschuif standaardpoorten.--profile <name>: isoleer status onder~/.openclaw-<name>.--no-color: schakel ANSI-kleuren uit.--update: verkorting vooropenclaw update(alleen source-installaties).-V,--version,-v: toon versie en sluit af.
Uitvoerstyling
- ANSI-kleuren en voortgangsindicatoren worden alleen weergegeven in TTY-sessies.
- OSC-8-hyperlinks worden als klikbare links weergegeven in ondersteunde terminals; anders vallen we terug op gewone URL’s.
--json(en--plainwaar ondersteund) schakelt styling uit voor schone uitvoer.--no-colorschakelt ANSI-styling uit;NO_COLOR=1wordt ook gerespecteerd.- Langlopende opdrachten tonen een voortgangsindicator (OSC 9;4 waar ondersteund).
Kleurenpalet
OpenClaw gebruikt een lobster-palet voor CLI-uitvoer.accent(#FF5A2D): koppen, labels, primaire accenten.accentBright(#FF7A3D): opdrachtnamen, nadruk.accentDim(#D14A22): secundaire accenttekst.info(#FF8A5B): informatieve waarden.success(#2FBF71): successtatussen.warn(#FFB020): waarschuwingen, fallbacks, aandacht.error(#E23D2D): fouten, mislukkingen.muted(#8B7F77): minder nadruk, metadata.
src/terminal/palette.ts (ook wel “lobster seam”).
Opdrachtboom
openclaw voicecall).
Beveiliging
openclaw security audit— audit config + lokale status op veelvoorkomende beveiligingsvalkuilen.openclaw security audit --deep— best-effort live Gateway-probe.openclaw security audit --fix— verscherp veilige standaardinstellingen en chmod status/config.
Plugins
Beheer extensies en hun config:openclaw plugins list— ontdek plugins (gebruik--jsonvoor machine-uitvoer).openclaw plugins info <id>— toon details voor een plugin.openclaw plugins install <path|.tgz|npm-spec>— installeer een plugin (of voeg een pluginpad toe aanplugins.load.paths).openclaw plugins enable <id>/disable <id>— schakelplugins.entries.<id>.enabledin/uit.openclaw plugins doctor— rapporteer plugin-laadfouten.
Memory
Vectorzoekopdrachten overMEMORY.md + memory/*.md:
openclaw memory status— toon indexstatistieken.openclaw memory index— herindexeer memory-bestanden.openclaw memory search "<query>"— semantisch zoeken over memory.
Chat slash-opdrachten
Chatberichten ondersteunen/...-opdrachten (tekst en native). Zie /tools/slash-commands.
Hoogtepunten:
/statusvoor snelle diagnostiek./configvoor persistente configwijzigingen./debugvoor alleen-runtime config-overschrijvingen (memory, niet schijf; vereistcommands.debug: true).
Installatie + onboarding
setup
Initialiseer config + werkruimte.
Opties:
--workspace <dir>: agent-werkruimtepad (standaard~/.openclaw/workspace).--wizard: voer de onboardingwizard uit.--non-interactive: voer de wizard uit zonder prompts.--mode <local|remote>: wizardmodus.--remote-url <url>: externe Gateway-URL.--remote-token <token>: extern Gateway-token.
--non-interactive, --mode, --remote-url, --remote-token).
onboard
Interactieve wizard om gateway, werkruimte en skills in te stellen.
Opties:
--workspace <dir>--reset(reset config + referenties + sessies + werkruimte vóór de wizard)--non-interactive--mode <local|remote>--flow <quickstart|advanced|manual>(manual is een alias voor advanced)--auth-choice <setup-token|token|chutes|openai-codex|openai-api-key|openrouter-api-key|ai-gateway-api-key|moonshot-api-key|moonshot-api-key-cn|kimi-code-api-key|synthetic-api-key|venice-api-key|gemini-api-key|zai-api-key|apiKey|minimax-api|minimax-api-lightning|opencode-zen|skip>--token-provider <id>(niet-interactief; gebruikt met--auth-choice token)--token <token>(niet-interactief; gebruikt met--auth-choice token)--token-profile-id <id>(niet-interactief; standaard:<provider>:manual)--token-expires-in <duration>(niet-interactief; bijv.365d,12h)--anthropic-api-key <key>--openai-api-key <key>--openrouter-api-key <key>--ai-gateway-api-key <key>--moonshot-api-key <key>--kimi-code-api-key <key>--gemini-api-key <key>--zai-api-key <key>--minimax-api-key <key>--opencode-zen-api-key <key>--custom-base-url <url>(niet-interactief; gebruikt met--auth-choice custom-api-key)--custom-model-id <id>(niet-interactief; gebruikt met--auth-choice custom-api-key)--custom-api-key <key>(niet-interactief; optioneel; gebruikt met--auth-choice custom-api-key; valt terug opCUSTOM_API_KEYindien weggelaten)--custom-provider-id <id>(niet-interactief; optionele aangepaste provider-id)--custom-compatibility <openai|anthropic>(niet-interactief; optioneel; standaardopenai)--gateway-port <port>--gateway-bind <loopback|lan|tailnet|auto|custom>--gateway-auth <token|password>--gateway-token <token>--gateway-password <password>--remote-url <url>--remote-token <token>--tailscale <off|serve|funnel>--tailscale-reset-on-exit--install-daemon--no-install-daemon(alias:--skip-daemon)--daemon-runtime <node|bun>--skip-channels--skip-skills--skip-health--skip-ui--node-manager <npm|pnpm|bun>(pnpm aanbevolen; bun niet aanbevolen voor Gateway-runtime)--json
configure
Interactieve configuratiewizard (models, kanalen, skills, gateway).
config
Niet-interactieve confighelpers (get/set/unset). Het uitvoeren van openclaw config zonder
subopdracht start de wizard.
Subopdrachten:
config get <path>: print een configwaarde (punt-/haakpad).config set <path> <value>: stel een waarde in (JSON5 of ruwe string).config unset <path>: verwijder een waarde.
doctor
Healthchecks + snelle fixes (config + gateway + legacy-services).
Opties:
--no-workspace-suggestions: schakel hints voor werkruimte-memory uit.--yes: accepteer standaardwaarden zonder prompts (headless).--non-interactive: sla prompts over; pas alleen veilige migraties toe.--deep: scan systeemservices op extra gateway-installaties.
Kanaalhelpers
channels
Beheer chatkanaalaccounts (WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage/Microsoft Teams).
Subopdrachten:
channels list: toon geconfigureerde kanalen en auth-profielen.channels status: controleer gateway-bereikbaarheid en kanaalgezondheid (--probevoert extra controles uit; gebruikopenclaw healthofopenclaw status --deepvoor gateway-healthprobes).- Tip:
channels statustoont waarschuwingen met voorgestelde oplossingen wanneer veelvoorkomende misconfiguraties worden gedetecteerd (en verwijst je daarna naaropenclaw doctor). channels logs: toon recente kanaallogs uit het gateway-logbestand.channels add: wizard-achtige installatie wanneer geen flags worden doorgegeven; flags schakelen over naar niet-interactieve modus.channels remove: standaard uitgeschakeld; geef--deletemee om configitems zonder prompts te verwijderen.channels login: interactieve kanaallogin (alleen WhatsApp Web).channels logout: meld je af bij een kanaalsessie (indien ondersteund).
--channel <name>:whatsapp|telegram|discord|googlechat|slack|mattermost|signal|imessage|msteams--account <id>: kanaalaccount-id (standaarddefault)--name <label>: weergavenaam voor het account
channels login-opties:
--channel <channel>(standaardwhatsapp; ondersteuntwhatsapp/web)--account <id>--verbose
channels logout-opties:
--channel <channel>(standaardwhatsapp)--account <id>
channels list-opties:
--no-usage: sla snapshots van gebruik/quota van modelproviders over (alleen OAuth/API-ondersteund).--json: voer JSON uit (inclusief gebruik tenzij--no-usageis ingesteld).
channels logs-opties:
--channel <name|all>(standaardall)--lines <n>(standaard200)--json
skills
Lijst en inspecteer beschikbare skills plus gereedheidsinformatie.
Subopdrachten:
skills list: lijst skills (standaard wanneer geen subopdracht).skills info <name>: toon details voor één skill.skills check: samenvatting van gereed vs. ontbrekende vereisten.
--eligible: toon alleen gereede skills.--json: voer JSON uit (geen styling).-v,--verbose: voeg details over ontbrekende vereisten toe.
npx clawhub om skills te zoeken, installeren en synchroniseren.
pairing
Keur DM-koppelingsverzoeken over kanalen goed.
Subopdrachten:
pairing list <channel> [--json]pairing approve <channel> <code> [--notify]
webhooks gmail
Gmail Pub/Sub-hookinstallatie + runner. Zie /automation/gmail-pubsub.
Subopdrachten:
webhooks gmail setup(vereist--account <email>; ondersteunt--project,--topic,--subscription,--label,--hook-url,--hook-token,--push-token,--bind,--port,--path,--include-body,--max-bytes,--renew-minutes,--tailscale,--tailscale-path,--tailscale-target,--push-endpoint,--json)webhooks gmail run(runtime-overschrijvingen voor dezelfde flags)
dns setup
Wide-area discovery DNS-helper (CoreDNS + Tailscale). Zie /gateway/discovery.
Opties:
--apply: installeer/update CoreDNS-config (vereist sudo; alleen macOS).
Messaging + agent
message
Uniforme uitgaande messaging + kanaalacties.
Zie: /cli/message
Subopdrachten:
message send|poll|react|reactions|read|edit|delete|pin|unpin|pins|permissions|search|timeout|kick|banmessage thread <create|list|reply>message emoji <list|upload>message sticker <send|upload>message role <info|add|remove>message channel <info|list>message member infomessage voice statusmessage event <list|create>
openclaw message send --target +15555550123 --message "Hi"openclaw message poll --channel discord --target channel:123 --poll-question "Snack?" --poll-option Pizza --poll-option Sushi
agent
Voer één agentbeurt uit via de Gateway (of --local ingebed).
Vereist:
--message <text>
--to <dest>(voor sessiesleutel en optionele levering)--session-id <id>--thinking <off|minimal|low|medium|high|xhigh>(alleen GPT-5.2 + Codex-modellen)--verbose <on|full|off>--channel <whatsapp|telegram|discord|slack|mattermost|signal|imessage|msteams>--local--deliver--json--timeout <seconds>
agents
Beheer geïsoleerde agents (werkruimtes + auth + routering).
agents list
Lijst geconfigureerde agents.
Opties:
--json--bindings
agents add [name]
Voeg een nieuwe geïsoleerde agent toe. Start de begeleide wizard tenzij flags (of --non-interactive) worden doorgegeven; --workspace is vereist in niet-interactieve modus.
Opties:
--workspace <dir>--model <id>--agent-dir <dir>--bind <channel[:accountId]>(herhaalbaar)--non-interactive--json
channel[:accountId]. Wanneer accountId wordt weggelaten voor WhatsApp, wordt de standaard account-id gebruikt.
agents delete <id>
Verwijder een agent en snoei diens werkruimte + status.
Opties:
--force--json
acp
Voer de ACP-bridge uit die IDE’s met de Gateway verbindt.
Zie acp voor alle opties en voorbeelden.
status
Toon gekoppelde sessiegezondheid en recente ontvangers.
Opties:
--json--all(volledige diagnose; alleen-lezen, plakbaar)--deep(probeer kanalen)--usage(toon gebruik/quota van modelproviders)--timeout <ms>--verbose--debug(alias voor--verbose)
- Het overzicht bevat de status van de Gateway + node-hostservice wanneer beschikbaar.
Gebruik volgen
OpenClaw kan gebruik/quota van providers tonen wanneer OAuth/API-referenties beschikbaar zijn. Vereist:/status(voegt een korte regel met providergebruik toe wanneer beschikbaar)openclaw status --usage(print een volledige provideruitsplitsing)- macOS-menubalk (sectie Gebruik onder Context)
- Gegevens komen rechtstreeks van provider-usage-endpoints (geen schattingen).
- Providers: Anthropic, GitHub Copilot, OpenAI Codex OAuth, plus Gemini CLI/Antigravity wanneer die providerplugins zijn ingeschakeld.
- Als er geen passende referenties bestaan, wordt gebruik verborgen.
- Details: zie Usage tracking.
health
Haal health op van de draaiende Gateway.
Opties:
--json--timeout <ms>--verbose
sessions
Lijst opgeslagen conversatiesessies.
Opties:
--json--verbose--store <path>--active <minutes>
Resetten / Verwijderen
reset
Reset lokale config/status (houdt de CLI geïnstalleerd).
Opties:
--scope <config|config+creds+sessions|full>--yes--non-interactive--dry-run
--non-interactivevereist--scopeen--yes.
uninstall
Verwijder de gatewayservice + lokale gegevens (CLI blijft).
Opties:
--service--state--workspace--app--all--yes--non-interactive--dry-run
--non-interactivevereist--yesen expliciete scopes (of--all).
Gateway
gateway
Start de WebSocket-Gateway.
Opties:
--port <port>--bind <loopback|tailnet|lan|auto|custom>--token <token>--auth <token|password>--password <password>--tailscale <off|serve|funnel>--tailscale-reset-on-exit--allow-unconfigured--dev--reset(reset dev-config + referenties + sessies + werkruimte)--force(beëindig bestaande listener op poort)--verbose--claude-cli-logs--ws-log <auto|full|compact>--compact(alias voor--ws-log compact)--raw-stream--raw-stream-path <path>
gateway service
Beheer de Gateway-service (launchd/systemd/schtasks).
Subopdrachten:
gateway status(probeert standaard de Gateway RPC)gateway install(service-installatie)gateway uninstallgateway startgateway stopgateway restart
gateway statusprobeert standaard de Gateway RPC met de door de service opgeloste poort/config (overschrijf met--url/--token/--password).gateway statusondersteunt--no-probe,--deepen--jsonvoor scripting.gateway statustoont ook legacy- of extra gatewayservices wanneer deze kunnen worden gedetecteerd (--deepvoegt systeemniveau-scans toe). Profielgenaamde OpenClaw-services worden als eersteklas beschouwd en niet als “extra” gemarkeerd.gateway statusprint welk configpad de CLI gebruikt versus welke config de service waarschijnlijk gebruikt (service-env), plus de opgeloste probe-doel-URL.gateway install|uninstall|start|stop|restartondersteunt--jsonvoor scripting (standaarduitvoer blijft mensvriendelijk).gateway installgebruikt standaard de Node-runtime; bun wordt niet aanbevolen (WhatsApp/Telegram-bugs).gateway install-opties:--port,--runtime,--token,--force,--json.
logs
Tail Gateway-bestandslogs via RPC.
Notities:
- TTY-sessies renderen een gekleurde, gestructureerde weergave; niet-TTY valt terug op platte tekst.
--jsonproduceert regel-gescheiden JSON (één logevent per regel).
gateway <subcommand>
Gateway CLI-helpers (gebruik --url, --token, --password, --timeout, --expect-final voor RPC-subopdrachten).
Wanneer je --url doorgeeft, past de CLI niet automatisch config- of omgevingsreferenties toe.
Voeg --token of --password expliciet toe. Ontbrekende expliciete referenties is een fout.
Subopdrachten:
gateway call <method> [--params <json>]gateway healthgateway statusgateway probegateway discovergateway install|uninstall|start|stop|restartgateway run
config.apply(valideer + schrijf config + herstart + wekken)config.patch(voeg een gedeeltelijke update samen + herstart + wekken)update.run(voer update uit + herstart + wekken)
config.set/config.apply/config.patch direct aanroept, geef baseHash mee uit
config.get als er al een config bestaat.
Models
Zie /concepts/models voor fallback-gedrag en scanstrategie. Voorkeursauthenticatie voor Anthropic (setup-token):models (root)
openclaw models is een alias voor models status.
Root-opties:
--status-json(alias voormodels status --json)--status-plain(alias voormodels status --plain)
models list
Opties:
--all--local--provider <name>--json--plain
models status
Opties:
--json--plain--check(exit 1=verlopen/ontbrekend, 2=verloopt binnenkort)--probe(live probe van geconfigureerde auth-profielen)--probe-provider <name>--probe-profile <id>(herhaal of komma-gescheiden)--probe-timeout <ms>--probe-concurrency <n>--probe-max-tokens <n>
--probe voert live verzoeken uit (kan tokens verbruiken en rate limits triggeren).
models set <model>
Stel agents.defaults.model.primary in.
models set-image <model>
Stel agents.defaults.imageModel.primary in.
models aliases list|add|remove
Opties:
list:--json,--plainadd <alias> <model>remove <alias>
models fallbacks list|add|remove|clear
Opties:
list:--json,--plainadd <model>remove <model>clear
models image-fallbacks list|add|remove|clear
Opties:
list:--json,--plainadd <model>remove <model>clear
models scan
Opties:
--min-params <b>--max-age-days <days>--provider <name>--max-candidates <n>--timeout <ms>--concurrency <n>--no-probe--yes--no-input--set-default--set-image--json
models auth add|setup-token|paste-token
Opties:
add: interactieve auth-helpersetup-token:--provider <name>(standaardanthropic),--yespaste-token:--provider <name>,--profile-id <id>,--expires-in <duration>
models auth order get|set|clear
Opties:
get:--provider <name>,--agent <id>,--jsonset:--provider <name>,--agent <id>,<profileIds...>clear:--provider <name>,--agent <id>
Systeem
system event
Plaats een systeemevenement in de wachtrij en trigger optioneel een heartbeat (Gateway RPC).
Vereist:
--text <text>
--mode <now|next-heartbeat>--json--url,--token,--timeout,--expect-final
system heartbeat last|enable|disable
Heartbeat-bediening (Gateway RPC).
Opties:
--json--url,--token,--timeout,--expect-final
system presence
Lijst systeem-presence-items (Gateway RPC).
Opties:
--json--url,--token,--timeout,--expect-final
Cron
Beheer geplande taken (Gateway RPC). Zie /automation/cron-jobs. Subopdrachten:cron status [--json]cron list [--all] [--json](standaard tabeluitvoer; gebruik--jsonvoor ruw)cron add(alias:create; vereist--nameen precies één van--at|--every|--cron, en precies één payload van--system-event|--message)cron edit <id>(patch velden)cron rm <id>(aliassen:remove,delete)cron enable <id>cron disable <id>cron runs --id <id> [--limit <n>]cron run <id> [--force]
cron-opdrachten accepteren --url, --token, --timeout, --expect-final.
Node-host
node draait een headless node-host of beheert deze als achtergrondservice. Zie
openclaw node.
Subopdrachten:
node run --host <gateway-host> --port 18789node statusnode install [--host <gateway-host>] [--port <port>] [--tls] [--tls-fingerprint <sha256>] [--node-id <id>] [--display-name <name>] [--runtime <node|bun>] [--force]node uninstallnode stopnode restart
Nodes
nodes communiceert met de Gateway en richt zich op gekoppelde nodes. Zie /nodes.
Veelgebruikte opties:
--url,--token,--timeout,--json
nodes status [--connected] [--last-connected <duration>]nodes describe --node <id|name|ip>nodes list [--connected] [--last-connected <duration>]nodes pendingnodes approve <requestId>nodes reject <requestId>nodes rename --node <id|name|ip> --name <displayName>nodes invoke --node <id|name|ip> --command <command> [--params <json>] [--invoke-timeout <ms>] [--idempotency-key <key>]nodes run --node <id|name|ip> [--cwd <path>] [--env KEY=VAL] [--command-timeout <ms>] [--needs-screen-recording] [--invoke-timeout <ms>] <command...>(mac-node of headless node-host)nodes notify --node <id|name|ip> [--title <text>] [--body <text>] [--sound <name>] [--priority <passive|active|timeSensitive>] [--delivery <system|overlay|auto>] [--invoke-timeout <ms>](alleen mac)
nodes camera list --node <id|name|ip>nodes camera snap --node <id|name|ip> [--facing front|back|both] [--device-id <id>] [--max-width <px>] [--quality <0-1>] [--delay-ms <ms>] [--invoke-timeout <ms>]nodes camera clip --node <id|name|ip> [--facing front|back] [--device-id <id>] [--duration <ms|10s|1m>] [--no-audio] [--invoke-timeout <ms>]
nodes canvas snapshot --node <id|name|ip> [--format png|jpg|jpeg] [--max-width <px>] [--quality <0-1>] [--invoke-timeout <ms>]nodes canvas present --node <id|name|ip> [--target <urlOrPath>] [--x <px>] [--y <px>] [--width <px>] [--height <px>] [--invoke-timeout <ms>]nodes canvas hide --node <id|name|ip> [--invoke-timeout <ms>]nodes canvas navigate <url> --node <id|name|ip> [--invoke-timeout <ms>]nodes canvas eval [<js>] --node <id|name|ip> [--js <code>] [--invoke-timeout <ms>]nodes canvas a2ui push --node <id|name|ip> (--jsonl <path> | --text <text>) [--invoke-timeout <ms>]nodes canvas a2ui reset --node <id|name|ip> [--invoke-timeout <ms>]nodes screen record --node <id|name|ip> [--screen <index>] [--duration <ms|10s>] [--fps <n>] [--no-audio] [--out <path>] [--invoke-timeout <ms>]
nodes location get --node <id|name|ip> [--max-age <ms>] [--accuracy <coarse|balanced|precise>] [--location-timeout <ms>] [--invoke-timeout <ms>]
Browser
Browserbedienings-CLI (toegewijde Chrome/Brave/Edge/Chromium). Zieopenclaw browser en de Browser-tool.
Veelgebruikte opties:
--url,--token,--timeout,--json--browser-profile <name>
browser statusbrowser startbrowser stopbrowser reset-profilebrowser tabsbrowser open <url>browser focus <targetId>browser close [targetId]browser profilesbrowser create-profile --name <name> [--color <hex>] [--cdp-url <url>]browser delete-profile --name <name>
browser screenshot [targetId] [--full-page] [--ref <ref>] [--element <selector>] [--type png|jpeg]browser snapshot [--format aria|ai] [--target-id <id>] [--limit <n>] [--interactive] [--compact] [--depth <n>] [--selector <sel>] [--out <path>]
browser navigate <url> [--target-id <id>]browser resize <width> <height> [--target-id <id>]browser click <ref> [--double] [--button <left|right|middle>] [--modifiers <csv>] [--target-id <id>]browser type <ref> <text> [--submit] [--slowly] [--target-id <id>]browser press <key> [--target-id <id>]browser hover <ref> [--target-id <id>]browser drag <startRef> <endRef> [--target-id <id>]browser select <ref> <values...> [--target-id <id>]browser upload <paths...> [--ref <ref>] [--input-ref <ref>] [--element <selector>] [--target-id <id>] [--timeout-ms <ms>]browser fill [--fields <json>] [--fields-file <path>] [--target-id <id>]browser dialog --accept|--dismiss [--prompt <text>] [--target-id <id>] [--timeout-ms <ms>]browser wait [--time <ms>] [--text <value>] [--text-gone <value>] [--target-id <id>]browser evaluate --fn <code> [--ref <ref>] [--target-id <id>]browser console [--level <error|warn|info>] [--target-id <id>]browser pdf [--target-id <id>]
Documentatie zoeken
docs [query...]
Doorzoek de live documentatie-index.
TUI
tui
Open de terminal-UI die is verbonden met de Gateway.
Opties:
--url <url>--token <token>--password <password>--session <key>--deliver--thinking <level>--message <text>--timeout-ms <ms>(standaardagents.defaults.timeoutSeconds)--history-limit <n>