Référence CLI

Référence des commandes miravo : cycle de vie, mutations du runtime, exports, inspection de contenu et opérations de plateforme.

Contrôlez le cycle de vie de l'environnement, modifiez un runtime actif, inspectez le contenu et automatisez les opérations de plateforme depuis des shells, des jobs CI, des health checks et des scripts de reprise.

Options globales

Option	Rôle
`--debug`	Imprime les stack traces des erreurs inattendues
`--verbose`	Raccourci pour `--log-level debug`
`--quiet`	Supprime toute sortie sauf les erreurs
`--plain`	Garde une sortie texte stable
`--log-level <level>`	Sélectionne `debug`, `info`, `warn` ou `error`
`--log-format <format>`	Sélectionne `pretty` ou `json`

Commandes

Groupe	Commandes
Cycle de vie	`start` · `stop` · `pause` · `resume` · `speed` · `load` · `reset`
Inspection	`status` · `logs`
Instances	`spawn` · `remove` · `inject`
Adaptateurs	`adapter`
Contenu	`models` · `templates` · `fork`
Plateforme	`export` · `apply` · `cleanup` · `platforms`
Shell	`completion`

miravo completion

Imprimez un script de completion statique pour Bash, Zsh ou Fish. Le script complète les commandes, les alias, les options et les valeurs fixes d'options. Il ne parcourt pas le système de fichiers. Il n'appelle pas Miravo pendant la completion.

mkdir -p ~/.local/share/bash-completion/completions
miravo completion bash > ~/.local/share/bash-completion/completions/miravo

Pour Zsh, gardez ~/.zsh/completions dans fpath avant compinit.

fpath=(~/.zsh/completions $fpath)

Ouvrez un nouveau shell après l'écriture du fichier de completion.

Argument	Rôle
`shell`	`bash`, `zsh` ou `fish`

Effets de bord : écrit le script sur stdout. La redirection crée le fichier de completion.

Codes de sortie : 0 succès, 1 shell non pris en charge.

miravo start

Démarrez un environnement depuis un template intégré, un template local ou une liste de templates séparés par des virgules.

miravo start -t smart-factory

Flag	Rôle
`-t, --template <id\|name\|path,...>`	Choisit le template de boot ou une liste boot+load séparée par des virgules
`-n, --name <name>`	Remplace le nom de l'environnement
`-d, --detach`	Lance dans un seul processus d'arrière-plan
`--dry-run`	Valide la configuration et affiche le résumé sans démarrer
`-s, --speed <multiplier>`	Définit le multiplicateur de temps
`--no-mqtt`	Désactive le broker MQTT intégré

Flag	Défaut	Rôle
`-n, --name <name>`	Dérivé du template ou du namespace	Nom de l'environnement
`-t, --template <id\|name\|path,...>`	Auto-détecté	ID, nom, chemin ou liste de templates séparés par des virgules
`--catalog-dir <path>`	`MIRAVO_CATALOG_DIR`	Racine du catalogue
`--models-dir <path>`	Non défini	Chemin de recherche supplémentaire pour les modèles
`-s, --speed <multiplier>`	`1`	Multiplicateur de temps
`--seed <number>`	Aléatoire	Graine RNG déterministe
`--tick <ms>`	`1000`	Intervalle de tick
`-p, --mqtt-port <number>`	`1883`	Port MQTT
`--mqtt-host <host>`	`0.0.0.0`	Hôte de bind MQTT
`--mqtt-mode <mode>`	`embedded`	Mode MQTT : `embedded` ou `external`
`--mqtt-url <url>`	Non défini	URL du broker MQTT externe
`--mqtt-username <username>`	Non défini	Nom d'utilisateur MQTT externe
`--mqtt-password <password>`	Non défini	Mot de passe MQTT externe
`--no-mqtt`	Activé	Désactive MQTT
`--opcua`	Désactivé sauf si le template l'active	Active OPC UA
`--opcua-port <number>`	`4840`	Port OPC UA
`--opcua-host <host>`	Valeur par défaut de l'adaptateur	Hôte de bind OPC UA
`--modbus`	Désactivé sauf si le template l'active	Active Modbus TCP
`--modbus-port <number>`	`502`	Port Modbus
`--modbus-host <host>`	Valeur par défaut de l'adaptateur	Hôte de bind Modbus
`--admin-host <host>`	`0.0.0.0`	Hôte de bind admin
`--admin-port <number>`	`8080`	Port de bind admin
`-d, --detach`	`false`	Démarre comme processus détaché
`--dry-run`	`false`	Valide sans démarrer
`--no-ui`	UI activée	Désactive la Console intégrée
`--no-auth`	Auth activée	Désactive l'auth admin
`--reset-state`	`false`	Ignore tout snapshot enregistré
`--summary-interval <seconds>`	`5`	Secondes entre les lignes de résumé

Effets de bord : démarre le moteur, le serveur admin, les adaptateurs activés et la Console intégrée sauf si --no-ui est défini. Le mode détaché écrit des métadonnées de runtime sous ~/.miravo.

Codes de sortie : 0 succès ou validation dry-run, 1 entrée ou configuration invalide, 2 échec d'une dépendance de démarrage.

miravo status

Lisez l'état du moteur en direct, les métriques et les détails d'instance depuis un environnement actif.

miravo status

Flag	Rôle
`--watch`	Surveille et redessine la vue d'état
`--instance <id>`	Cible une instance
`--json`	Émet du JSON lisible machine
`--discover`	Découvre les runtimes via MQTT puis quitte

Flag	Défaut	Rôle
`--name <name>`	Non défini	Cible un environnement nommé
`--discover`	`false`	Découvre puis quitte
`-w, --watch`	`false`	Surveille les mises à jour en continu
`--instance <id>`	Non défini	Affiche une instance unique
`--json`	`false`	Sortie lisible machine
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--template <path>`	`MIRAVO_TEMPLATE`	Informations de connexion MQTT pour la découverte
`--timeout <seconds>`	`5`	Délai de requête admin

Effets de bord : lecture seule. --discover utilise MQTT au lieu du serveur admin.

Codes de sortie : 0 succès, 1 URL admin invalide ou entrée locale invalide, 2 échec de transport, 3 rejet du runtime.

miravo stop

Demandez l'arrêt propre d'un environnement détaché.

miravo stop

Flag	Défaut	Rôle
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--json`	`false`	Sortie lisible machine
`--timeout <seconds>`	`10`	Délai d'arrêt

Effets de bord : arrête la cible détachée et efface le pointeur local vers le mode détaché quand cette cible correspond au runtime local.

Codes de sortie : 0 succès, 1 échec de résolution de cible locale, 2 échec de transport, 3 rejet du runtime.

miravo logs

Diffusez les événements de domaine d'un environnement détaché sur WebSocket.

miravo logs

Flag	Défaut	Rôle
`--tail <n>`	Non défini	Récupère les `n` derniers événements avant le stream
`--channels <list>`	Tous sauf `tick`	Limite les canaux
`--json`	`false`	Émet du NDJSON
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin

Effets de bord : ouvre une connexion de stream et garde le processus attaché jusqu'à interruption.

Codes de sortie : 0 fermeture propre du stream, 1 échec de résolution de cible locale, 2 échec de transport.

miravo spawn

Créez de nouvelles instances à partir d'un nom de modèle.

miravo spawn centrifugal-pump

Flag	Défaut	Rôle
`-c, --count <n>`	`1`	Nombre d'instances à créer
`--json`	`false`	Sortie lisible machine
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--timeout <seconds>`	`5`	Délai de requête admin

Effets de bord : crée de nouvelles instances. Relancer la commande en crée encore.

Codes de sortie : 0 succès, 1 entrée invalide, 2 échec de transport, 3 rejet du runtime.

miravo remove

Supprimez une instance par ID.

miravo remove pump-003

miravo remove pump-003 --yes

Flag	Défaut	Rôle
`--yes`	`false`	Ignore l'invite de confirmation
`--json`	`false`	Sortie lisible machine
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--timeout <seconds>`	`5`	Délai de requête admin

Effets de bord : supprime l'instance ciblée. Les exécutions TTY demandent confirmation sauf avec --yes. Les exécutions non interactives exigent --yes.

Codes de sortie : 0 succès, 1 entrée invalide ou confirmation manquante, 2 échec de transport, 3 rejet du runtime.

miravo pause

Mettez en pause l'environnement actif sans détruire l'état.

miravo pause

Flag	Défaut	Rôle
`--json`	`false`	Sortie lisible machine
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--timeout <seconds>`	`5`	Délai de requête admin

Effets de bord : arrête l'avancement des ticks tout en gardant l'état du runtime en mémoire.

Codes de sortie : 0 succès, 1 entrée invalide, 2 échec de transport, 3 rejet du runtime.

miravo resume

Reprenez un environnement en pause.

miravo resume

Flag	Défaut	Rôle
`--json`	`false`	Sortie lisible machine
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--timeout <seconds>`	`5`	Délai de requête admin

Effets de bord : reprend l'avancement des ticks pour le runtime actuel.

Codes de sortie : 0 succès, 1 entrée invalide, 2 échec de transport, 3 rejet du runtime.

miravo speed

Réglez le multiplicateur de temps d'un environnement actif.

miravo speed 10

Flag	Défaut	Rôle
`--json`	`false`	Sortie lisible machine
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--timeout <seconds>`	`5`	Délai de requête admin

Effets de bord : change immédiatement la vitesse du runtime.

Codes de sortie : 0 succès, 1 multiplicateur invalide ou entrée locale invalide, 2 échec de transport, 3 rejet du runtime.

miravo load

Chargez des instances supplémentaires dans un environnement actif.

miravo load -t smart-factory

Flag	Rôle
`templateArg`	ID, nom, chemin de template ou `-` pour stdin
`-t, --template <id\|name\|path,...>`	Sélecteur de template quand aucun argument positionnel n'est utilisé
`-c, --count <n>`	Nombre de copies à charger par template
`--dry-run`	Affiche la requête de chargement sans l'envoyer

Flag	Défaut	Rôle
`templateArg`	Non défini	ID, nom, chemin de template ou `-` pour stdin
`-t, --template <id\|name\|path,...>`	`MIRAVO_TEMPLATE`	Sélecteur de template
`--catalog-dir <path>`	`MIRAVO_CATALOG_DIR`	Racine du catalogue
`-c, --count <n>`	`1`	Copies à charger par template
`--dry-run`	`false`	Affiche sans muter le runtime
`--json`	`false`	Sortie lisible machine
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--timeout <seconds>`	`5`	Délai de requête admin

Effets de bord : crée des instances supplémentaires ou des exécutions de template. Relancer la même commande ajoute encore du contenu au runtime.

Codes de sortie : 0 succès ou dry-run, 1 entrée invalide ou template manquant, 2 échec de transport, 3 rejet du runtime.

miravo reset

Supprimez toutes les instances et toutes les exécutions de template.

miravo reset

Flag	Défaut	Rôle
`--clear-persistence`	`false`	Supprime l'état enregistré pour le prochain boot
`--yes`	`false`	Ignore l'invite de confirmation
`--json`	`false`	Sortie lisible machine
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--timeout <seconds>`	`5`	Délai de requête admin

Effets de bord : vide l'état du runtime en mémoire. --clear-persistence supprime aussi le snapshot persistant. Les exécutions TTY demandent confirmation sauf avec --yes. Les exécutions non interactives exigent --yes.

Codes de sortie : 0 succès, 1 entrée invalide ou confirmation manquante, 2 échec de transport, 3 rejet du runtime.

miravo inject

Déclenchez ou effacez des défauts sur une instance active.

miravo inject

Flag	Défaut	Rôle
`--clear`	`false`	Efface le défaut nommé au lieu de le déclencher
`--json`	`false`	Sortie lisible machine
`--name <name>`	Non défini	Cible un nom d'environnement
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--timeout <seconds>`	`5`	Délai de requête admin

Effets de bord : modifie l'état des défauts du runtime. Sans argument positionnel, ouvre le sélecteur interactif sur un TTY.

Codes de sortie : 0 succès, 1 entrée invalide ou TTY manquant pour le mode interactif, 2 échec de transport, 3 rejet du runtime.

miravo adapter

Gérez les adaptateurs de protocole du runtime.

enable

miravo adapter enable mqtt

Flag	Défaut	Rôle
`-p, --port <number>`	Valeur par défaut de l'adaptateur	Remplace le port de l'adaptateur
`--host <host>`	Valeur par défaut de l'adaptateur	Remplace l'hôte de bind
`--json`	`false`	Sortie lisible machine
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--timeout <seconds>`	`5`	Délai de requête admin

disable

miravo adapter disable opcua

Flag	Défaut	Rôle
`--json`	`false`	Sortie lisible machine
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--timeout <seconds>`	`5`	Délai de requête admin

inspect

miravo adapter inspect modbus --json

Flag	Défaut	Rôle
`name`	`modbus`	Inspecte une interface d'adaptateur
`--json`	`false`	Sortie lisible machine
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--timeout <seconds>`	`5`	Délai de requête admin

Effets de bord : enable et disable mutent l'état vivant des adaptateurs. inspect est en lecture seule.

Codes de sortie : 0 succès, 1 nom d'adaptateur invalide ou entrée locale invalide, 2 échec de transport, 3 rejet du runtime.

miravo export

Exportez des payloads de plateforme depuis le contenu local ou un runtime actif. Le préfixe de sous-commande identifie la plateforme cible — les sous-commandes le-* ciblent Litmus Edge. Console alternative : Console plateformes.

le-template

miravo export le-template -t smart-factory

Flag	Défaut	Rôle
`-t, --template <id>`	Requis	ID, nom ou chemin de template
`--host <hostname>`	`localhost`	Hostname source présent dans les endpoints des devices
`--protocol <name>`	Protocole du template	Remplace le protocole par `opcua`, `modbus` ou `mqtt`
`-o, --output <prefix>`	ID du template	Préfixe de sortie pour `.le-template.json` et `-tags.csv`
`--models-dir <path>`	Non défini	Chemin de recherche supplémentaire pour les modèles
`--catalog-dir <path>`	`MIRAVO_CATALOG_DIR`	Racine du catalogue

Effets de bord : écrit <prefix>.le-template.json et <prefix>-tags.csv. Aucun environnement actif n'est requis.

le-tags

miravo export le-tags --device DTW-FAB-PLC --protocol opcua

Flag	Défaut	Rôle
`--device <name>`	Requis	Nom du device Litmus Edge
`--protocol <name>`	Requis	`opcua`, `modbus` ou `mqtt`
`--instance <id>`	Toutes	Restreint l'export à une instance
`-o, --output <file>`	stdout	Écrit le CSV dans un fichier
`--admin-url <url>`	Ordre de résolution des URL	Remplace la cible admin
`--timeout <seconds>`	`5`	Délai de requête admin

Effets de bord : lit le manifeste du runtime puis imprime ou écrit le CSV.

le-dt

miravo export le-dt centrifugal-pump

Flag	Défaut	Rôle
`model`	Requis	Nom du modèle à exporter
`-o, --output <file>`	stdout	Écrit le JSON dans un fichier
`--catalog-dir <path>`	`MIRAVO_CATALOG_DIR`	Racine du catalogue

Effets de bord : lit le YAML du modèle local puis imprime ou écrit un seul JSON de modèle Digital Twin au format Litmus Edge. Aucun environnement actif n'est requis.

Codes de sortie : 0 succès, 1 entrée locale invalide ou contenu local manquant, 2 échec de transport du manifeste pour le-tags.

miravo apply

Appliquez des ressources Miravo à une plateforme externe. Le premier argument est la cible de plateforme. Utilisez le ou litmus-edge pour Litmus Edge. D'autres plateformes sont en développement. Alternative Console : Console plateformes.

miravo apply le --target demo --template smart-factory --dry-run

Flag	Rôle
`--target <label>`	Utilise une cible plateforme enregistrée
`--template <path>`	Choisit le template à provisionner
`--source-hostname <host>`	Définit l'adresse que la plateforme utilise pour atteindre Miravo
`--protocol <name>`	Choisit `mqtt`, `opcua` ou `modbus`
`--scope <scope>`	Limite le plan aux types de ressources choisis
`--dry-run`	Imprime le plan sans l'appliquer

Flag	Défaut	Rôle
`--target <label>`	Non défini	Cible nommée issue de `~/.miravo/platforms/targets.json`
`--le-hostname <host>`	`LITMUS_EDGE_HOSTNAME` ou cible enregistrée	Hostname ou IP Litmus Edge
`--le-api-token <token>`	`LITMUS_EDGE_API_TOKEN` ou cible enregistrée	Token API Litmus Edge
`--catalog-dir <path>`	`MIRAVO_CATALOG_DIR`	Racine du catalogue
`--template <path>`	Requis	Nom de template ou chemin de fichier
`--protocol <name>`	Protocole du template ou `opcua`	Protocole
`--scope <scope>`	`devices,models,instances`	Scope des ressources
`--area <name>`	Non défini	Filtre par area
`--line <name>`	Non défini	Filtre par line
`--instance <id>`	Non défini	Filtre par instance
`--source-hostname <host>`	`MIRAVO_SOURCE_HOSTNAME` ou cible enregistrée	Hostname source
`--if-unmanaged <policy>`	`fail`	Politique de collision : `fail` ou `skip`
`--dry-run`	`false`	Imprime seulement le plan
`--json`	`false`	Émet le plan en JSON

Effets de bord : le dry-run ne fait qu'établir un plan. Une exécution mutatrice vérifie l'auth de la plateforme, résout l'état désiré puis crée ou met à jour les devices, modèles et instances gérés.

Codes de sortie : 0 succès, 1 entrée invalide, blocages ou échecs du plan, 2 échec de transport de la plateforme, 3 rejet de la plateforme distante.

miravo cleanup

Supprimez des ressources Miravo gérées depuis une plateforme externe. Le premier argument est la cible de plateforme. Utilisez le ou litmus-edge pour Litmus Edge. D'autres plateformes sont en développement. Alternative Console : Console plateformes.

miravo cleanup le --target demo --template smart-factory --dry-run

Flag	Rôle
`--template <path>`	Restreint le cleanup à un template
`--all-managed`	Supprime toutes les ressources gérées par Miravo
`--scope <scope>`	Limite le cleanup aux types de ressources choisis
`--dry-run`	Imprime le plan de cleanup sans supprimer
`--yes`	Confirme un cleanup mutateur

Flag	Défaut	Rôle
`--target <label>`	Non défini	Cible nommée issue de `~/.miravo/platforms/targets.json`
`--le-hostname <host>`	`LITMUS_EDGE_HOSTNAME` ou cible enregistrée	Hostname ou IP Litmus Edge
`--le-api-token <token>`	`LITMUS_EDGE_API_TOKEN` ou cible enregistrée	Token API Litmus Edge
`--catalog-dir <path>`	`MIRAVO_CATALOG_DIR`	Racine du catalogue pour la résolution du template
`--template <path>`	Requis sauf avec `--all-managed`	Nom de template ou chemin de fichier
`--scope <scope>`	`instances,models,devices`	Scope des ressources
`--area <name>`	Non défini	Filtre par area
`--line <name>`	Non défini	Filtre par line
`--instance <id>`	Non défini	Filtre par instance
`--all-managed`	`false`	Ignore le scope du template et supprime toutes les ressources gérées
`--dry-run`	`false`	Imprime seulement le plan
`--json`	`false`	Émet le plan en JSON
`--yes`	`false`	Ignore l'invite de confirmation

Effets de bord : une exécution mutatrice supprime les instances, modèles et devices gérés dans l'ordre des dépendances. La commande réessaie les opérations de cleanup en échec avant de quitter.

Codes de sortie : 0 succès, 1 entrée invalide, confirmation manquante ou échecs de cleanup, 2 échec de transport de la plateforme, 3 rejet de la plateforme distante.

miravo platforms

Gérez les cibles plateforme enregistrées. Console alternative : Console plateformes.

Les cibles enregistrées sont stockées sous ~/.miravo/platforms/targets.json. La commande résout d'abord les ID exacts, puis les libellés exacts, sans tenir compte de la casse.

Effets de bord : add, update et remove mutent le store des cibles enregistrées. remove demande confirmation sur TTY sauf avec --yes; les exécutions non interactives exigent --yes. test envoie une sonde légère à Litmus Edge.

Codes de sortie : 0 succès, 1 entrée invalide ou test de connectivité en échec, 2 échec de transport de la plateforme externe.

miravo models

Listez ou inspectez les modèles d'asset découvrables. miravo models et miravo models list font le même travail.

Effets de bord : lecture seule.

Codes de sortie : 0 succès, 1 modèle manquant ou mauvais chemin local.

miravo templates

Listez ou inspectez les templates découvrables. miravo templates et miravo templates list font le même travail.

Effets de bord : lecture seule.

Codes de sortie : 0 succès, 1 template manquant ou mauvais chemin local.

miravo fork

Copiez un modèle ou un template dans le registre local pour le personnaliser.

model

miravo fork model centrifugal-pump

Flag	Défaut	Rôle
`--force`	`false`	Écrase une copie locale existante
`--catalog-dir <path>`	`MIRAVO_CATALOG_DIR`	Racine du catalogue

template

miravo fork template water-treatment

Flag	Défaut	Rôle
`--force`	`false`	Écrase une copie locale existante
`--models-only`	`false`	Copie uniquement les modèles référencés
`--catalog-dir <path>`	`MIRAVO_CATALOG_DIR`	Racine du catalogue

Effets de bord : écrit des fichiers sous ~/.miravo/registry/local/models et ~/.miravo/registry/local/templates.

Codes de sortie : 0 succès, 1 contenu manquant ou conflit d'écriture.

Référence

Code de sortie	Signification
`0`	La commande a réussi
`1`	Mauvais arguments, entrée locale invalide, TTY manquant, contenu manquant ou échec de validation
`2`	Échec de transport ou d'environnement
`3`	Le runtime ou la plateforme externe a rejeté l'action demandée

Surface	Runtime Miravo requis
`start`, `models`, `templates`, `fork`, `completion`, `export le-template`, `export le-dt`	Non
`status`, `stop`, `logs`, `spawn`, `remove`, `pause`, `resume`, `speed`, `load`, `reset`, `inject`, `adapter`, `export le-tags`	Oui
`apply le` / `apply litmus-edge`, `cleanup le` / `cleanup litmus-edge`, `platforms target *`	Aucun runtime Miravo. Utilise Litmus Edge ou le store local de cibles

Référence CLI

Options globales

Commandes

miravo completion

miravo start

miravo status

miravo stop

miravo logs

miravo spawn

miravo remove

miravo pause

miravo resume

miravo speed

miravo load

miravo reset

miravo inject

miravo adapter

enable

disable

inspect

miravo export

le-template

le-tags

le-dt

miravo apply

miravo cleanup

miravo platforms

miravo models

miravo templates

miravo fork

model

template

Référence

Pages liées

Plateformes

Litmus Edge

Variables d'environnement

Journalisation

On this page

Référence CLI

miravo completion

miravo start

miravo status

miravo logs

miravo reset

miravo inject

miravo adapter

enable

disable

inspect

miravo export

le-template

le-tags

le-dt

miravo apply

miravo cleanup

miravo platforms

Liste

Ajout

Inspection

Mise à jour

Suppression

Test

miravo models

list

inspect

miravo templates

list

inspect

miravo fork

model

template

Plateformes

Litmus Edge

Variables d'environnement

Journalisation

On this page