Quick Start

Install MiravoCopy Anchor Link

curl -fsSL https://miravo.dev/install | bash

Let your agent run itCopy Anchor Link

Install the Miravo Skill so your agent knows how to use Miravo. The install script offers to do this for you; otherwise run:

miravo skill install

It works with Claude Code, Codex and any agent that loads Agent Skills. Then ask in plain language:

• "Give me a bottling line I can point Grafana at over MQTT, and show me what happens when the capper jams."
• "I need OPC UA data from a water plant for my historian."
• "My SCADA polls Modbus: simulate a building's HVAC and give me the register map."

The agent picks or builds the factory, runs it, checks that values move and tells you how to connect. Ask it to add faults, change the plant or stop the run the same way. More in AI Agents.

Or run it yourselfCopy Anchor Link

Start a built-in template from the shell and check the data yourself.

Start a factoryCopy Anchor Link

miravo start -t smart-factory

smart-factory is the default template: a seven-asset machining line. To run another one, pass its name, for example -t water-treatment. See Templates for the list.

Without -t, Miravo uses a template in the current folder or resumes the one saved factory, if there is one. Otherwise a terminal shows a picker with smart-factory as the default. With --no-input, -d, --dry-run or no terminal, it starts smart-factory directly.

Built-in templates enable MQTT, OPC UA and Modbus TCP together. MQTT listens on 1883, OPC UA on 4840, Modbus TCP on 1502 and the Console on 8080. All bind to 127.0.0.1.

To get the shell back, run it in the background.

miravo start -t smart-factory -d

Flags, detached mode and dry run: miravo start. If something fails, see Troubleshooting.

Open the ConsoleCopy Anchor Link

Connect your systemCopy Anchor Link

Check that data flowsCopy Anchor Link

Pick a protocol. Each check should show values that keep changing.

npx mqtt sub -h 127.0.0.1 -p 1883 -t 'MiravoWorks/smart-factory/#' -v