CLI commands
Configuration
Aides de configuration pour les modifications non interactives dans OmeniaClaw.json : obtenir/définir/corriger/supprimer/fichier/schéma/valider des valeurs par chemin et afficher le fichier de configuration actif. Exécutez sans sous-commande pour ouvrir l’assistant de configuration (identique à OmeniaClaw configure).
Options racine
OmeniaClaw_DOCS_MARKER:paramOpen:IHBhdGg9Ii0tc2VjdGlvbiA8c2VjdGlvbg
" type="string">
Filtre de section de configuration guidée répétable lorsque vous exécutez OmeniaClaw config sans sous-commande.
Sections guidées prises en charge : workspace, model, web, gateway, daemon, channels, plugins, skills, health.
Exemples
OmeniaClaw config fileOmeniaClaw config --section modelOmeniaClaw config --section gateway --section daemonOmeniaClaw config schemaOmeniaClaw config get browser.executablePathOmeniaClaw config set browser.executablePath "/usr/bin/google-chrome"OmeniaClaw config set browser.profiles.work.executablePath "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"OmeniaClaw config set agents.defaults.heartbeat.every "2h"OmeniaClaw config set agents.list[0].tools.exec.node "node-id-or-name"OmeniaClaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --mergeOmeniaClaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKENOmeniaClaw config set secrets.providers.vaultfile --provider-source file --provider-path /etc/OmeniaClaw/secrets.json --provider-mode jsonOmeniaClaw config patch --file ./OmeniaClaw.patch.json5 --dry-runOmeniaClaw config unset plugins.entries.brave.config.webSearch.apiKeyOmeniaClaw config set channels.discord.token --ref-provider default --ref-source env --ref-id DISCORD_BOT_TOKEN --dry-runOmeniaClaw config validateOmeniaClaw config validate --jsonconfig schema
Affiche le schéma JSON généré pour OmeniaClaw.json sur stdout au format JSON.
What it includes
- Le schéma de configuration racine actuel, plus un champ chaîne
$schemaracine pour les outils d’édition. - Les métadonnées de documentation
titleetdescriptiondes champs utilisées par l’interface de contrôle. - Les nœuds d’objet imbriqué, de joker (
*) et d’élément de tableau ([]) héritent des mêmes métadonnéestitle/descriptionlorsqu’une documentation de champ correspondante existe. - Les branches
anyOf/oneOf/allOfhéritent elles aussi des mêmes métadonnées de documentation lorsqu’une documentation de champ correspondante existe. - Métadonnées de schéma de Plugin + canal en direct, au mieux, lorsque les manifestes d’exécution peuvent être chargés.
- Un schéma de repli propre même lorsque la configuration actuelle est invalide.
Related runtime RPC
config.schema.lookup renvoie un chemin de configuration normalisé avec un nœud de schéma superficiel (title, description, type, enum, const, bornes communes), les métadonnées d’indice d’interface correspondantes et les résumés des enfants immédiats. Utilisez-le pour l’exploration limitée à un chemin dans l’interface de contrôle ou des clients personnalisés.
OmeniaClaw config schemaRedirigez-le vers un fichier lorsque vous voulez l’inspecter ou le valider avec d’autres outils :
OmeniaClaw config schema > OmeniaClaw.schema.jsonChemins
Les chemins utilisent la notation par point ou par crochets :
OmeniaClaw config get agents.defaults.workspaceOmeniaClaw config get agents.list[0].idUtilisez l’index de la liste d’agents pour cibler un agent précis :
OmeniaClaw config get agents.listOmeniaClaw config set agents.list[1].tools.exec.node "node-id-or-name"Valeurs
Les valeurs sont analysées comme du JSON5 lorsque c’est possible ; sinon elles sont traitées comme des chaînes. Utilisez --strict-json pour exiger l’analyse JSON5. --json reste pris en charge comme alias hérité.
OmeniaClaw config set agents.defaults.heartbeat.every "0m"OmeniaClaw config set gateway.port 19001 --strict-jsonOmeniaClaw config set channels.whatsapp.groups '["*"]' --strict-jsonconfig get <path> --json affiche la valeur brute en JSON au lieu d’un texte formaté pour le terminal.
Utilisez --merge lorsque vous ajoutez des entrées à ces mappes :
OmeniaClaw config set agents.defaults.models '{"openai/gpt-5.4":{}}' --strict-json --mergeOmeniaClaw config set models.providers.ollama.models '[{"id":"llama3.2","name":"Llama 3.2"}]' --strict-json --mergeUtilisez --replace uniquement lorsque vous voulez intentionnellement que la valeur fournie devienne la valeur cible complète.
Modes de config set
OmeniaClaw config set prend en charge quatre styles d’affectation :
Value mode
OmeniaClaw config set <path> <value>SecretRef builder mode
OmeniaClaw config set channels.discord.token \ --ref-provider default \ --ref-source env \ --ref-id DISCORD_BOT_TOKENProvider builder mode
Le mode constructeur de fournisseur cible uniquement les chemins secrets.providers.<alias> :
OmeniaClaw config set secrets.providers.vault \ --provider-source exec \ --provider-command /usr/local/bin/OmeniaClaw-vault \ --provider-arg read \ --provider-arg openai/api-key \ --provider-timeout-ms 5000Batch mode
OmeniaClaw config set --batch-json '[ { "path": "secrets.providers.default", "provider": { "source": "env" } }, { "path": "channels.discord.token", "ref": { "source": "env", "provider": "default", "id": "DISCORD_BOT_TOKEN" } }]'OmeniaClaw config set --batch-file ./config-set.batch.json --dry-runL’analyse par lots utilise toujours la charge utile de lot (--batch-json/--batch-file) comme source de vérité. --strict-json / --json ne modifient pas le comportement d’analyse par lots.
config patch
Utilisez config patch lorsque vous voulez coller ou transmettre par pipe un correctif ayant la forme d’une configuration, plutôt que d’exécuter de nombreuses commandes config set basées sur des chemins. L’entrée est un objet JSON5. Les objets sont fusionnés récursivement, les tableaux et les valeurs scalaires remplacent la valeur cible, et null supprime le chemin cible.
OmeniaClaw config patch --file ./OmeniaClaw.patch.json5 --dry-runOmeniaClaw config patch --file ./OmeniaClaw.patch.json5Vous pouvez aussi transmettre un correctif par stdin, ce qui est utile pour les scripts de configuration à distance :
ssh OmeniaClaw-host 'OmeniaClaw config patch --stdin --dry-run' < ./OmeniaClaw.patch.json5ssh OmeniaClaw-host 'OmeniaClaw config patch --stdin' < ./OmeniaClaw.patch.json5Exemple de correctif :
{ channels: { slack: { enabled: true, mode: "socket", botToken: { source: "env", provider: "default", id: "SLACK_BOT_TOKEN" }, appToken: { source: "env", provider: "default", id: "SLACK_APP_TOKEN" }, groupPolicy: "open", requireMention: false, }, discord: { enabled: true, token: { source: "env", provider: "default", id: "DISCORD_BOT_TOKEN" }, dmPolicy: "disabled", dm: { enabled: false }, groupPolicy: "allowlist", }, }, agents: { defaults: { model: { primary: "openai/gpt-5.5" }, models: { "openai/gpt-5.5": { params: { fastMode: true } }, }, }, },}Utilisez --replace-path <path> lorsqu’un objet ou un tableau doit devenir exactement la valeur fournie au lieu d’être corrigé récursivement :
OmeniaClaw config patch --file ./discord.patch.json5 --replace-path 'channels.discord.guilds["123"].channels'--dry-run exécute les vérifications de schéma et de résolubilité SecretRef sans écrire. Les SecretRefs basés sur exec sont ignorés par défaut pendant l’exécution à blanc ; ajoutez --allow-exec lorsque vous voulez intentionnellement que l’exécution à blanc exécute des commandes de fournisseur.
Le mode chemin/valeur JSON reste pris en charge pour les SecretRefs comme pour les fournisseurs :
OmeniaClaw config set channels.discord.token \ '{"source":"env","provider":"default","id":"DISCORD_BOT_TOKEN"}' \ --strict-json OmeniaClaw config set secrets.providers.vaultfile \ '{"source":"file","path":"/etc/OmeniaClaw/secrets.json","mode":"json"}' \ --strict-jsonOptions du constructeur de fournisseur
Les cibles du constructeur de fournisseur doivent utiliser secrets.providers.<alias> comme chemin.
Common flags
--provider-source <env|file|exec>--provider-timeout-ms <ms>(file,exec)
Env provider (--provider-source env)
--provider-allowlist <ENV_VAR>(répétable)
File provider (--provider-source file)
--provider-path <path>(obligatoire)--provider-mode <singleValue|json>--provider-max-bytes <bytes>--provider-allow-insecure-path
Exec provider (--provider-source exec)
--provider-command <path>(obligatoire)--provider-arg <arg>(répétable)--provider-no-output-timeout-ms <ms>--provider-max-output-bytes <bytes>--provider-json-only--provider-env <KEY=VALUE>(répétable)--provider-pass-env <ENV_VAR>(répétable)--provider-trusted-dir <path>(répétable)--provider-allow-insecure-path--provider-allow-symlink-command
Exemple de fournisseur exec renforcé :
OmeniaClaw config set secrets.providers.vault \ --provider-source exec \ --provider-command /usr/local/bin/OmeniaClaw-vault \ --provider-arg read \ --provider-arg openai/api-key \ --provider-json-only \ --provider-pass-env VAULT_TOKEN \ --provider-trusted-dir /usr/local/bin \ --provider-timeout-ms 5000Exécution à blanc
Utilisez --dry-run pour valider les changements sans écrire dans OmeniaClaw.json.
OmeniaClaw config set channels.discord.token \ --ref-provider default \ --ref-source env \ --ref-id DISCORD_BOT_TOKEN \ --dry-run OmeniaClaw config set channels.discord.token \ --ref-provider default \ --ref-source env \ --ref-id DISCORD_BOT_TOKEN \ --dry-run \ --json OmeniaClaw config set channels.discord.token \ --ref-provider vault \ --ref-source exec \ --ref-id discord/token \ --dry-run \ --allow-execDry-run behavior
- Mode constructeur : exécute les vérifications de résolubilité SecretRef pour les références/fournisseurs modifiés.
- Mode JSON (
--strict-json,--jsonou mode par lots) : exécute la validation de schéma plus les vérifications de résolubilité SecretRef. - La validation de politique s’exécute également pour les surfaces cibles SecretRef connues comme non prises en charge.
- Les vérifications de politique évaluent la configuration complète après changement, donc les écritures d’objets parents (par exemple définir
hookscomme objet) ne peuvent pas contourner la validation des surfaces non prises en charge. - Les vérifications SecretRef exec sont ignorées par défaut pendant l’exécution à blanc afin d’éviter les effets de bord des commandes.
- Utilisez
--allow-execavec--dry-runpour accepter explicitement les vérifications SecretRef exec (cela peut exécuter des commandes de fournisseur). --allow-execest réservé à l’exécution à blanc et génère une erreur s’il est utilisé sans--dry-run.
--dry-run --json fields
--dry-run --json affiche un rapport lisible par machine :
ok: indique si la simulation a réussioperations: nombre d’affectations évaluéeschecks: indique si les vérifications de schéma/résolvabilité ont été exécutéeschecks.resolvabilityComplete: indique si les vérifications de résolvabilité ont été exécutées jusqu’au bout (false lorsque les références exec sont ignorées)refsChecked: nombre de références effectivement résolues pendant la simulationskippedExecRefs: nombre de références exec ignorées parce que--allow-execn’était pas définierrors: échecs structurés de schéma/résolvabilité lorsqueok=false
Structure de la sortie JSON
{ ok: boolean, operations: number, configPath: string, inputModes: ["value" | "json" | "builder", ...], checks: { schema: boolean, resolvability: boolean, resolvabilityComplete: boolean, }, refsChecked: number, skippedExecRefs: number, errors?: [ { kind: "schema" | "resolvability", message: string, ref?: string, // present for resolvability errors }, ],}Exemple de réussite
{ "ok": true, "operations": 1, "configPath": "~/.OmeniaClaw/OmeniaClaw.json", "inputModes": ["builder"], "checks": { "schema": false, "resolvability": true, "resolvabilityComplete": true }, "refsChecked": 1, "skippedExecRefs": 0}Exemple d’échec
{ "ok": false, "operations": 1, "configPath": "~/.OmeniaClaw/OmeniaClaw.json", "inputModes": ["builder"], "checks": { "schema": false, "resolvability": true, "resolvabilityComplete": true }, "refsChecked": 1, "skippedExecRefs": 0, "errors": [ { "kind": "resolvability", "message": "Error: Environment variable \"MISSING_TEST_SECRET\" is not set.", "ref": "env:default:MISSING_TEST_SECRET" } ]}Si la simulation échoue
config schema validation failed: la structure de votre configuration après modification est invalide ; corrigez le chemin/la valeur ou la structure de l’objet provider/ref.Config policy validation failed: unsupported SecretRef usage: replacez cet identifiant en entrée texte brut/chaîne et gardez les SecretRefs uniquement sur les surfaces prises en charge.SecretRef assignment(s) could not be resolved: le provider/la référence indiqués ne peuvent actuellement pas être résolus (variable d’environnement manquante, pointeur de fichier invalide, échec du provider exec ou incompatibilité provider/source).Dry run note: skipped <n> exec SecretRef resolvability check(s): la simulation a ignoré les références exec ; relancez avec--allow-execsi vous avez besoin de valider leur résolvabilité.- En mode batch, corrigez les entrées en échec et relancez
--dry-runavant l’écriture.
Sécurité d’écriture
OmeniaClaw config set et les autres outils d’écriture de configuration appartenant à OmeniaClaw valident toute la configuration après modification avant de l’enregistrer sur le disque. Si la nouvelle charge utile échoue à la validation du schéma ou ressemble à un écrasement destructeur, la configuration active est laissée intacte et la charge utile rejetée est enregistrée à côté sous le nom OmeniaClaw.json.rejected.*.
Préférez les écritures via la CLI pour les petites modifications :
OmeniaClaw config set gateway.reload.mode hybrid --dry-runOmeniaClaw config set gateway.reload.mode hybridOmeniaClaw config validateSi une écriture est rejetée, inspectez la charge utile enregistrée et corrigez la structure complète de la configuration :
CONFIG="$(OmeniaClaw config file)"ls -lt "$CONFIG".rejected.* 2>/dev/null | headOmeniaClaw config validateLes écritures directes dans un éditeur restent autorisées, mais le Gateway en cours d’exécution les traite comme non fiables jusqu’à ce qu’elles soient validées. Les modifications directes invalides font échouer le démarrage ou sont ignorées par le rechargement à chaud ; Gateway ne réécrit pas OmeniaClaw.json. Exécutez OmeniaClaw doctor --fix pour réparer une configuration préfixée/écrasée ou restaurer la dernière copie connue comme valide. Voir Dépannage de Gateway.
La récupération de fichier entier est réservée à la réparation par doctor. Les changements de schéma de Plugin ou les écarts de minHostVersion restent visibles au lieu d’annuler des paramètres utilisateur sans rapport, comme les modèles, providers, profils d’authentification, canaux, exposition du Gateway, outils, mémoire, navigateur ou configuration Cron.
Sous-commandes
config file: affiche le chemin du fichier de configuration actif (résolu depuisOmeniaClaw_CONFIG_PATHou l’emplacement par défaut). Le chemin doit désigner un fichier ordinaire, pas un lien symbolique.
Redémarrez le gateway après les modifications.
Valider
Validez la configuration actuelle par rapport au schéma actif sans démarrer le gateway.
OmeniaClaw config validateOmeniaClaw config validate --jsonAprès la réussite de OmeniaClaw config validate, vous pouvez utiliser la TUI locale pour qu’un agent intégré compare la configuration active avec la documentation pendant que vous validez chaque changement depuis le même terminal :
OmeniaClaw chatPuis dans la TUI :
!OmeniaClaw config file!OmeniaClaw docs gateway auth token secretref!OmeniaClaw config validate!OmeniaClaw doctorBoucle de réparation typique :
Comparer avec la documentation
Demandez à l’agent de comparer votre configuration actuelle avec la page de documentation pertinente et de suggérer la plus petite correction.
Appliquer des modifications ciblées
Appliquez des modifications ciblées avec OmeniaClaw config set ou OmeniaClaw configure.
Revalider
Relancez OmeniaClaw config validate après chaque changement.
Doctor pour les problèmes d’exécution
Si la validation réussit mais que l’exécution reste défaillante, exécutez OmeniaClaw doctor ou OmeniaClaw doctor --fix pour obtenir de l’aide sur la migration et la réparation.