CLI commands
Référence de la CLI
openclaw est le point d’entrée principal de la CLI. Chaque commande principale dispose d’une
page de référence dédiée ou est documentée avec la commande dont elle est l’alias ; cet index répertorie
les commandes, les options globales et les règles de mise en forme de la sortie qui s’appliquent à l’ensemble de la CLI.
Commandes de configuration selon l’objectif :
openclaw setupetopenclaw onboardvérifient d’abord l’inférence, puis démarrent Crestodian pour configurer le Gateway, l’espace de travail, les canaux, les Skills et l’état de santé.openclaw setup --baselinecrée la configuration de référence et l’espace de travail sans suivre le processus guidé d’intégration.openclaw configuremodifie des parties ciblées d’une configuration existante : authentification du modèle, Gateway, canaux, plugins ou Skills.openclaw channels addconfigure les comptes de canaux une fois la configuration de référence créée ; exécutez cette commande sans option pour une configuration guidée, ou avec des options propres au canal pour les scripts.
Pages des commandes
| Domaine | Commandes |
|---|---|
| Configuration et intégration | crestodian · setup · onboard · configure · config · completion · doctor · dashboard |
| Réinitialisation, sauvegarde et migration | backup · migrate · reset · uninstall · update |
| Messagerie et agents | message · agent · agents · attach · acp · mcp |
| État de santé et sessions | status · health · sessions · audit |
| Gateway et journaux | gateway · logs · system |
| Modèles et inférence | models · promos · infer · capability (alias de infer) · memory · commitments · wiki |
| Réseau et nœuds | directory · nodes · devices · node |
| Exécution et bac à sable | approvals · exec-policy (voir approvals) · sandbox · tui · chat/terminal (alias de tui --local) · browser |
| Automatisation | cron · tasks · hooks · webhooks · transcripts |
| Découverte et documentation | dns · docs |
| Appairage et canaux | pairing · qr · channels |
| Sécurité et plugins | security · secrets · skills · plugins · proxy |
| Alias hérités | daemon (service Gateway) · clawbot (espace de noms) |
| Plugins (facultatifs) | path · policy · voicecall · workboard (si installé) |
Options globales
| Option | Objectif |
|---|---|
--dev |
Isole l’état sous ~/.openclaw-dev, utilise par défaut le port 19001 pour le Gateway et décale les ports dérivés |
--profile <name> |
Isole l’état sous ~/.openclaw-<name> (OPENCLAW_STATE_DIR/OPENCLAW_CONFIG_PATH) |
--container <name> |
Exécute la CLI dans un conteneur Podman/Docker en cours d’exécution nommé <name> (valeur par défaut : variable d’environnement OPENCLAW_CONTAINER) |
--log-level <level> |
Remplace le niveau global de journalisation pour la sortie dans les fichiers et la console |
--no-color |
Désactive les couleurs ANSI (NO_COLOR=1 est également pris en compte) |
--update |
Raccourci pour openclaw update ; fonctionne aussi bien pour les extractions du code source que pour les installations de paquets |
-V, --version, -v |
Affiche la version et quitte |
Modes de sortie
- Les couleurs ANSI et les indicateurs de progression s’affichent uniquement dans les sessions TTY.
- Les hyperliens OSC-8 s’affichent sous forme de liens cliquables lorsque cela est pris en charge ; sinon, la CLI utilise des URL en texte brut.
--json(et--plainlorsqu’il est pris en charge) désactive la mise en forme pour produire une sortie épurée.- Les commandes de longue durée affichent un indicateur de progression (OSC 9;4 lorsque cela est pris en charge).
Palette de couleurs
OpenClaw utilise une palette inspirée du homard pour la sortie de la CLI :
| Jeton | Hexadécimal | Utilisation |
|---|---|---|
accent |
#FF5A2D |
Titres, libellés, mises en évidence principales |
accentBright |
#FF7A3D |
Noms de commandes, emphase |
accentDim |
#D14A22 |
Texte de mise en évidence secondaire |
info |
#FF8A5B |
Valeurs informatives |
success |
#2FBF71 |
États de réussite |
warn |
#FFB020 |
Avertissements, options, solutions de repli |
error |
#E23D2D |
Erreurs, échecs |
muted |
#8B7F77 |
Atténuation, métadonnées |
Source de référence de la palette : packages/terminal-core/src/palette.ts.
Arborescence des commandes
Arborescence complète des commandes
Cette carte couvre les commandes principales et leurs principales sous-commandes. Les sous-commandes ajoutées par les plugins
(par exemple sous skills, plugins et wiki) évoluent
indépendamment ; exécutez <command> --help pour obtenir la liste actuelle faisant autorité.
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)Les Plugins peuvent ajouter des commandes principales supplémentaires, telles que
openclaw workboard ou openclaw voicecall.
Commandes obliques de chat
Les messages de chat prennent en charge les commandes /.... Consultez Commandes obliques.
Points clés :
/status- diagnostics rapides./trace- lignes de traçage et de débogage du Plugin limitées à la session./config- modifications persistantes de la configuration./debug- substitutions de configuration limitées à l’exécution (en mémoire, pas sur disque ; nécessitecommands.debug: true).
Suivi de l’utilisation
openclaw status --usage et l’interface de contrôle affichent l’utilisation et le quota du fournisseur lorsque
des identifiants OAuth/API sont disponibles. Les données proviennent directement des points de terminaison
d’utilisation des fournisseurs et sont normalisées sous la forme X% left. Fournisseurs disposant actuellement
de fenêtres d’utilisation : Anthropic, Gemini CLI, GitHub Copilot, MiniMax, OpenAI Codex,
Xiaomi et z.ai.
Consultez Suivi de l’utilisation pour plus de détails.