Reference CLI
Cette page decrit le comportement actuel de la CLI. Si les commandes changent, mettez a jour ce document.Pages de commandes
setuponboardconfigureconfigdoctordashboardresetuninstallupdatemessageagentagentsacpstatushealthsessionsgatewaylogssystemmodelsmemorynodesdevicesnodeapprovalssandboxtuibrowsercrondnsdocshookswebhookspairingplugins(commandes de plugins)channelssecurityskillsvoicecall(plugin ; si installe)
Indicateurs globaux
--dev: isole l’etat sous~/.openclaw-devet decale les ports par defaut.--profile <name>: isole l’etat sous~/.openclaw-<name>.--no-color: desactive les couleurs ANSI.--update: raccourci pouropenclaw update(installations depuis les sources uniquement).-V,--version,-v: affiche la version et quitte.
Style de sortie
- Les couleurs ANSI et les indicateurs de progression ne s’affichent que dans les sessions TTY.
- Les hyperliens OSC-8 s’affichent comme des liens cliquables dans les terminaux pris en charge ; sinon, repli vers des URL en clair.
--json(et--plainle cas echeant) desactive le style pour une sortie propre.--no-colordesactive le style ANSI ;NO_COLOR=1est egalement respecte.- Les commandes longues affichent un indicateur de progression (OSC 9;4 lorsqu’il est pris en charge).
Palette de couleurs
OpenClaw utilise une palette « lobster » pour la sortie CLI.accent(#FF5A2D) : titres, etiquettes, mises en evidence principales.accentBright(#FF7A3D) : noms de commandes, emphase.accentDim(#D14A22) : texte de mise en evidence secondaire.info(#FF8A5B) : valeurs informatives.success(#2FBF71) : etats de succes.warn(#FFB020) : avertissements, replis, attention.error(#E23D2D) : erreurs, echecs.muted(#8B7F77) : attenuation, metadonnees.
src/terminal/palette.ts (alias « lobster seam »).
Arbre de commandes
openclaw voicecall).
Securite
openclaw security audit— audit de la configuration et de l’etat local pour les erreurs de securite courantes.openclaw security audit --deep— sonde en direct du Gateway (passerelle) avec effort maximal.openclaw security audit --fix— renforce les valeurs par defaut sures et applique chmod a l’etat/la configuration.
Plugins
Gererez les extensions et leur configuration :openclaw plugins list— decouvrir des plugins (utilisez--jsonpour une sortie machine).openclaw plugins info <id>— afficher les details d’un plugin.openclaw plugins install <path|.tgz|npm-spec>— installer un plugin (ou ajouter un chemin de plugin aplugins.load.paths).openclaw plugins enable <id>/disable <id>— activer/desactiverplugins.entries.<id>.enabled.openclaw plugins doctor— signaler les erreurs de chargement des plugins.
Memoire
Recherche vectorielle surMEMORY.md + memory/*.md :
openclaw memory status— afficher les statistiques de l’index.openclaw memory index— reindexer les fichiers de memoire.openclaw memory search "<query>"— recherche semantique dans la memoire.
Commandes slash de chat
Les messages de chat prennent en charge les commandes/... (texte et natives). Voir /tools/slash-commands.
Points forts :
/statuspour des diagnostics rapides./configpour des modifications de configuration persistantes./debugpour des surcharges de configuration uniquement a l’execution (memoire, pas disque ; necessitecommands.debug: true).
Configuration + prise en main
setup
Initialiser la configuration et l’espace de travail.
Options :
--workspace <dir>: chemin de l’espace de travail de l’agent (par defaut~/.openclaw/workspace).--wizard: lancer l’assistant de prise en main.--non-interactive: lancer l’assistant sans invites.--mode <local|remote>: mode de l’assistant.--remote-url <url>: URL distante du Gateway.--remote-token <token>: jeton du Gateway distant.
--non-interactive, --mode, --remote-url, --remote-token).
onboard
Assistant interactif pour configurer le gateway, l’espace de travail et les skills.
Options :
--workspace <dir>--reset(reinitialise configuration + informations d’identification + sessions + espace de travail avant l’assistant)--non-interactive--mode <local|remote>--flow <quickstart|advanced|manual>(manual est un alias de 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>(non interactif ; utilise avec--auth-choice token)--token <token>(non interactif ; utilise avec--auth-choice token)--token-profile-id <id>(non interactif ; par defaut :<provider>:manual)--token-expires-in <duration>(non interactif ; ex.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>(non interactif ; utilisé avec--auth-choice custom-api-key)--custom-model-id <id>(non interactif ; utilisé avec--auth-choice custom-api-key)--custom-api-key <key>(non interactif ; optionnel ; utilisé avec--auth-choice custom-api-key; utiliseCUSTOM_API_KEYpar défaut s’il est omis)--custom-provider-id <id>(non interactif ; identifiant de fournisseur personnalisé optionnel)--custom-compatibility <openai|anthropic>(non interactif ; optionnel ;openaipar défaut)--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 recommande ; bun non recommande pour l’execution du Gateway)--json
configure
Assistant interactif de configuration (modeles, canaux, skills, gateway).
config
Aides de configuration non interactives (get/set/unset). L’execution de openclaw config sans
sous-commande lance l’assistant.
Sous-commandes :
config get <path>: afficher une valeur de configuration (chemin point/crochets).config set <path> <value>: definir une valeur (JSON5 ou chaine brute).config unset <path>: supprimer une valeur.
doctor
Verifications d’etat + corrections rapides (configuration + gateway + services herites).
Options :
--no-workspace-suggestions: desactiver les indications de memoire de l’espace de travail.--yes: accepter les valeurs par defaut sans invites (sans interface).--non-interactive: ignorer les invites ; appliquer uniquement les migrations sures.--deep: analyser les services systeme pour des installations supplementaires du gateway.
Aides pour les canaux
channels
Gerer les comptes de canaux de chat (WhatsApp/Telegram/Discord/Google Chat/Slack/Mattermost (plugin)/Signal/iMessage/Microsoft Teams).
Sous-commandes :
channels list: afficher les canaux configures et les profils d’authentification.channels status: verifier l’accessibilite du gateway et l’etat des canaux (--probeeffectue des verifications supplementaires ; utilisezopenclaw healthouopenclaw status --deeppour les sondes d’etat du gateway).- Astuce :
channels statusaffiche des avertissements avec des correctifs suggeres lorsqu’il peut detecter des erreurs de configuration courantes (puis vous dirige versopenclaw doctor). channels logs: afficher les journaux recents des canaux depuis le fichier de log du gateway.channels add: configuration de type assistant lorsque aucun indicateur n’est fourni ; les indicateurs basculent en mode non interactif.channels remove: desactive par defaut ; passez--deletepour supprimer les entrees de configuration sans invites.channels login: connexion interactive a un canal (WhatsApp Web uniquement).channels logout: se deconnecter d’une session de canal (si pris en charge).
--channel <name>:whatsapp|telegram|discord|googlechat|slack|mattermost|signal|imessage|msteams--account <id>: identifiant du compte de canal (par defautdefault)--name <label>: nom d’affichage du compte
channels login :
--channel <channel>(par defautwhatsapp; prend en chargewhatsapp/web)--account <id>--verbose
channels logout :
--channel <channel>(par defautwhatsapp)--account <id>
channels list :
--no-usage: ignorer les instantanes d’utilisation/quota du fournisseur de modeles (OAuth/API uniquement).--json: sortie JSON (inclut l’utilisation sauf si--no-usageest defini).
channels logs :
--channel <name|all>(par defautall)--lines <n>(par defaut200)--json
skills
Lister et inspecter les skills disponibles ainsi que les informations de preparation.
Sous-commandes :
skills list: lister les skills (par defaut lorsque aucune sous-commande).skills info <name>: afficher les details d’un skill.skills check: resume des prets vs exigences manquantes.
--eligible: afficher uniquement les skills prets.--json: sortie JSON (sans style).-v,--verbose: inclure le detail des exigences manquantes.
npx clawhub pour rechercher, installer et synchroniser des skills.
pairing
Approuver les demandes d’appairage de DM à travers les canaux.
Sous-commandes :
pairing list <channel> [--json]pairing approve <channel> <code> [--notify]
webhooks gmail
Configuration et execution du hook Gmail Pub/Sub. Voir /automation/gmail-pubsub.
Sous-commandes :
webhooks gmail setup(necessite--account <email>; prend en charge--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(surcharges a l’execution pour les memes indicateurs)
dns setup
Assistant DNS de decouverte a grande echelle (CoreDNS + Tailscale). Voir /gateway/discovery.
Options :
--apply: installer/mettre a jour la configuration CoreDNS (necessite sudo ; macOS uniquement).
Messagerie + agent
message
Messagerie sortante unifiee + actions de canal.
Voir : /cli/message
Sous-commandes :
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
Executer un tour d’agent via le Gateway (ou --local integre).
Requis :
--message <text>
--to <dest>(pour la cle de session et la livraison optionnelle)--session-id <id>--thinking <off|minimal|low|medium|high|xhigh>(modeles GPT-5.2 + Codex uniquement)--verbose <on|full|off>--channel <whatsapp|telegram|discord|slack|mattermost|signal|imessage|msteams>--local--deliver--json--timeout <seconds>
agents
Gerer les agents isoles (espaces de travail + authentification + routage).
agents list
Lister les agents configures.
Options :
--json--bindings
agents add [name]
Ajouter un nouvel agent isole. Execute l’assistant guide sauf si des indicateurs (ou --non-interactive) sont fournis ; --workspace est requis en mode non interactif.
Options :
--workspace <dir>--model <id>--agent-dir <dir>--bind <channel[:accountId]>(repetable)--non-interactive--json
channel[:accountId]. Lorsque accountId est omis pour WhatsApp, l’identifiant de compte par defaut est utilise.
agents delete <id>
Supprimer un agent et purger son espace de travail et son etat.
Options :
--force--json
acp
Executer le pont ACP qui connecte les IDE au Gateway.
Voir acp pour les options completes et des exemples.
status
Afficher l’etat des sessions liees et les destinataires recents.
Options :
--json--all(diagnostic complet ; lecture seule, copiable)--deep(sonder les canaux)--usage(afficher l’utilisation/quota du fournisseur de modeles)--timeout <ms>--verbose--debug(alias de--verbose)
- La vue d’ensemble inclut l’etat du Gateway et du service hote de noeud lorsque disponible.
Suivi de l’utilisation
OpenClaw peut afficher l’utilisation/le quota des fournisseurs lorsque des informations d’identification OAuth/API sont disponibles. Surfaces :/status(ajoute une courte ligne d’utilisation du fournisseur lorsque disponible)openclaw status --usage(affiche la repartition complete par fournisseur)- Barre de menu macOS (section Utilisation sous Contexte)
- Les donnees proviennent directement des points d’extremite d’utilisation des fournisseurs (sans estimations).
- Fournisseurs : Anthropic, GitHub Copilot, OpenAI Codex OAuth, ainsi que Gemini CLI/Antigravity lorsque ces plugins de fournisseur sont actives.
- En l’absence d’informations d’identification correspondantes, l’utilisation est masquee.
- Details : voir Usage tracking.
health
Recupere l’etat de sante de la Gateway (passerelle) en cours d’execution.
Options :
--json--timeout <ms>--verbose
sessions
Lister les sessions de conversation stockees.
Options :
--json--verbose--store <path>--active <minutes>
Reinitialisation / Desinstallation
reset
Reinitialiser la configuration et l’etat locaux (la CLI reste installee).
Options :
--scope <config|config+creds+sessions|full>--yes--non-interactive--dry-run
--non-interactivenecessite--scopeet--yes.
uninstall
Desinstaller le service gateway et les donnees locales (la CLI reste).
Options :
--service--state--workspace--app--all--yes--non-interactive--dry-run
--non-interactivenecessite--yeset des portees explicites (ou--all).
Gateway
gateway
Executer le Gateway WebSocket.
Options :
--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(reinitialise la configuration de developpement + informations d’identification + sessions + espace de travail)--force(arrete l’ecouteur existant sur le port)--verbose--claude-cli-logs--ws-log <auto|full|compact>--compact(alias de--ws-log compact)--raw-stream--raw-stream-path <path>
gateway service
Gerer le service Gateway (launchd/systemd/schtasks).
Sous-commandes :
gateway status(sonde la RPC du Gateway par defaut)gateway install(installation du service)gateway uninstallgateway startgateway stopgateway restart
gateway statussonde la RPC du Gateway par defaut en utilisant le port/la configuration resolus du service (surcharge avec--url/--token/--password).gateway statusprend en charge--no-probe,--deepet--jsonpour le scripting.gateway statusexpose egalement les services gateway herites ou supplementaires lorsqu’il peut les detecter (--deepajoute des analyses au niveau systeme). Les services OpenClaw nommes par profil sont traites comme de premiere classe et ne sont pas signales comme « supplementaires ».gateway statusaffiche le chemin de configuration utilise par la CLI par rapport a celui probablement utilise par le service (env du service), ainsi que l’URL cible de la sonde resolue.gateway install|uninstall|start|stop|restartprend en charge--jsonpour le scripting (la sortie par defaut reste conviviale).gateway installutilise par defaut le runtime Node ; bun n’est pas recommande (bogues WhatsApp/Telegram).- Options de
gateway install:--port,--runtime,--token,--force,--json.
logs
Suivre les journaux de fichiers du Gateway via RPC.
Notes :
- Les sessions TTY affichent une vue structuree et colorisee ; les sessions non TTY reviennent au texte brut.
--jsonemet du JSON delimite par lignes (un evenement de journal par ligne).
gateway <subcommand>
Aides CLI du Gateway (utilisez --url, --token, --password, --timeout, --expect-final pour les sous-commandes RPC).
Lorsque vous passez --url, la CLI n’applique pas automatiquement la configuration ni les informations d’identification de l’environnement.
Incluez explicitement --token ou --password. L’absence d’informations d’identification explicites est une erreur.
Sous-commandes :
gateway call <method> [--params <json>]gateway healthgateway statusgateway probegateway discovergateway install|uninstall|start|stop|restartgateway run
config.apply(valider + ecrire la configuration + redemarrer + reveiller)config.patch(fusionner une mise a jour partielle + redemarrer + reveiller)update.run(executer la mise a jour + redemarrer + reveiller)
config.set/config.apply/config.patch, passez baseHash depuis
config.get si une configuration existe deja.
Modeles
Voir /concepts/models pour le comportement de repli et la strategie d’analyse. Authentification Anthropic preferee (setup-token) :models (racine)
openclaw models est un alias de models status.
Options racine :
--status-json(alias demodels status --json)--status-plain(alias demodels status --plain)
models list
Options :
--all--local--provider <name>--json--plain
models status
Options :
--json--plain--check(sortie 1 = expire/manquant, 2 = expirant)--probe(sonde en direct des profils d’authentification configures)--probe-provider <name>--probe-profile <id>(repetable ou separe par des virgules)--probe-timeout <ms>--probe-concurrency <n>--probe-max-tokens <n>
--probe execute des requetes en direct (peut consommer des jetons et declencher des limites de debit).
models set <model>
Definir agents.defaults.model.primary.
models set-image <model>
Definir agents.defaults.imageModel.primary.
models aliases list|add|remove
Options :
list:--json,--plainadd <alias> <model>remove <alias>
models fallbacks list|add|remove|clear
Options :
list:--json,--plainadd <model>remove <model>clear
models image-fallbacks list|add|remove|clear
Options :
list:--json,--plainadd <model>remove <model>clear
models scan
Options :
--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
Options :
add: assistant d’authentification interactifsetup-token:--provider <name>(par defautanthropic),--yespaste-token:--provider <name>,--profile-id <id>,--expires-in <duration>
models auth order get|set|clear
Options :
get:--provider <name>,--agent <id>,--jsonset:--provider <name>,--agent <id>,<profileIds...>clear:--provider <name>,--agent <id>
Systeme
system event
Mettre en file d’attente un evenement systeme et declencher optionnellement un battement (RPC du Gateway).
Requis :
--text <text>
--mode <now|next-heartbeat>--json--url,--token,--timeout,--expect-final
system heartbeat last|enable|disable
Commandes de battement (RPC du Gateway).
Options :
--json--url,--token,--timeout,--expect-final
system presence
Lister les entrees de presence systeme (RPC du Gateway).
Options :
--json--url,--token,--timeout,--expect-final
Cron
Gerer les taches planifiees (RPC du Gateway). Voir /automation/cron-jobs. Sous-commandes :cron status [--json]cron list [--all] [--json](sortie tabulaire par defaut ; utilisez--jsonpour le brut)cron add(alias :create; necessite--nameet exactement un de--at|--every|--cron, et exactement une charge utile de--system-event|--message)cron edit <id>(modifier des champs)cron rm <id>(alias :remove,delete)cron enable <id>cron disable <id>cron runs --id <id> [--limit <n>]cron run <id> [--force]
cron acceptent --url, --token, --timeout, --expect-final.
Hôte du noeud
node execute un hote de noeud sans interface ou le gere comme un service en arriere-plan. Voir
openclaw node.
Sous-commandes :
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
Noeuds
nodes communique avec le Gateway et cible les noeuds appaires. Voir /nodes.
Options courantes :
--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...>(noeud mac ou hote de noeud sans interface)nodes notify --node <id|name|ip> [--title <text>] [--body <text>] [--sound <name>] [--priority <passive|active|timeSensitive>] [--delivery <system|overlay|auto>] [--invoke-timeout <ms>](mac uniquement)
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>]
Navigateur
CLI de controle du navigateur (Chrome/Brave/Edge/Chromium dedies). Voiropenclaw browser et l’outil Navigateur.
Options courantes :
--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>]
Recherche dans la documentation
docs [query...]
Rechercher dans l’index de documentation en direct.
TUI
tui
Ouvrir l’interface utilisateur terminal connectee au Gateway.
Options :
--url <url>--token <token>--password <password>--session <key>--deliver--thinking <level>--message <text>--timeout-ms <ms>(par defautagents.defaults.timeoutSeconds)--history-limit <n>