CLI Reference

Complete command reference for the miravo CLI.

Global Options

Option	Default	Description
--log-level <level>	info	debug, info, warn, error
--log-format <format>	pretty	pretty or json
--verbose	—	Alias for --log-level debug
-q, --quiet	—	Suppress formatted output and non-error logs
--plain	—	Plain text output (no colors/formatting)

Priority: -q/--quiet > --log-level > --verbose. The NO_COLOR env var forces plain output.

miravo start

Start a simulation.

miravo start --template smart-factory
miravo start --template ./custom.miravo.yaml --name my-sim
miravo start -d  # Detach (background daemon)

Option	Env Var	Default	Description
-t, --template <name|path>	MIRAVO_TEMPLATE	Auto-select	Template to run
-n, --name <name>	MIRAVO_NAME	Template-derived	Simulation name
-s, --speed <n>	—	From template	Time multiplier
-p, --mqtt-port <port>	MIRAVO_MQTT_PORT	1883	MQTT broker port
--mqtt-host <host>	MIRAVO_MQTT_HOST	127.0.0.1	MQTT bind host
--mqtt-mode <mode>	MIRAVO_MQTT_MODE	embedded	embedded or external
--mqtt-url <url>	MIRAVO_MQTT_URL	—	External broker URL
--no-mqtt	—	—	Disable MQTT
--opcua	—	Disabled	Enable OPC UA
--opcua-port <port>	MIRAVO_OPCUA_PORT	4840	OPC UA port
--opcua-host <host>	MIRAVO_OPCUA_HOST	0.0.0.0	OPC UA bind host
--admin-port <port>	MIRAVO_ADMIN_PORT	8080	Admin HTTP port
--admin-host <host>	MIRAVO_ADMIN_HOST	127.0.0.1	Admin bind host
-d, --detach	—	—	Run as background daemon
--dry-run	—	—	Validate without running
--seed <n>	—	Random	RNG seed
--tick <ms>	—	From template	Tick interval
--summary-interval <s>	—	30	Periodic summary log interval

miravo ps

List running background simulations.

miravo ps
miravo ps --json

miravo stop

Stop a running simulation.

miravo stop my-sim
miravo stop my-sim --timeout 10

miravo logs

Stream domain events from a running simulation via WebSocket.

miravo logs my-sim
miravo logs my-sim --tail 50
miravo logs my-sim --channels faults,lifecycle

Available channels: tick, faults, lifecycle, instances, engine, adapters.

miravo status

View simulation metrics and state.

miravo status
miravo status --watch
miravo status --instance pump-001
miravo status --json
miravo status --discover    # MQTT-based discovery

miravo inject

Trigger or clear faults. Interactive picker when arguments are omitted.

miravo inject pump-001 cavitation
miravo inject pump-001 cavitation --clear
miravo inject    # Interactive mode (TTY)

miravo spawn

Add instances to the running simulation.

miravo spawn centrifugal-pump
miravo spawn centrifugal-pump --count 5

miravo remove

Remove an instance.

miravo remove pump-003

miravo pause / resume

miravo pause
miravo resume

miravo speed

Set the simulation time multiplier (1-1000).

miravo speed 50

miravo reset

Remove all instances and template runs.

miravo reset
miravo reset --clear-persistence

miravo load

Load additional instances from a template.

miravo load ./extra-pumps.miravo.yaml
miravo load smart-factory --count 2

miravo adapter

Manage protocol adapters at runtime.

miravo adapter enable opcua --port 4840
miravo adapter disable mqtt

miravo models

miravo models list
miravo models inspect centrifugal-pump
miravo models inspect centrifugal-pump --raw

miravo templates

miravo templates list
miravo templates inspect smart-factory
miravo templates inspect smart-factory --raw

miravo fork

Copy built-in content to the local registry for customization.

miravo fork model centrifugal-pump
miravo fork template smart-factory
miravo fork template smart-factory --models-only
miravo fork template smart-factory --force

miravo rm

Force-remove stale daemon registry entries.

miravo rm old-sim
miravo rm old-sim --force