@litmusio/miravo 0.15.10 → 0.16.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  <p align="center"><strong>Miravo</strong> (pronounced <code>mih-RAH-voh</code>) is an open-source factory simulator. Tell your agent the plant you need and it builds it, runs it and hands you the endpoints. Then break a machine and watch your software react.</p>
8
8
 
9
9
  <p align="center">
10
- <img src="https://miravo.litmus.dev/console-screenshot-2026-10-04.png" alt="Miravo Console" width="80%" />
10
+ <img src="https://miravo.litmus.dev/floors/smart-factory.webp" alt="Miravo factory floor" width="80%" />
11
11
  </p>
12
12
 
13
13
  ---
@@ -20,7 +20,16 @@ Paste this into Claude Code, Codex or any agent that loads Agent Skills:
20
20
  Set me up with Miravo. Fetch https://miravo.litmus.dev/agent-setup.md and follow it.
21
21
  ```
22
22
 
23
- Your agent installs Miravo and its skill, then asks how it can help. It offers four places to start, tailored to the project you have open: break a live production line, simulate the plant you run, run it through Litmus Edge, or feed your own software. Pick one, or say what you want in the same prompt. You get the Console link and every endpoint.
23
+ Your agent installs Miravo and offers you a running factory. Name your own plant in the prompt and it builds that instead.
24
+
25
+ Then ask in plain language:
26
+
27
+ - "Build a chocolate factory with tempering, enrobing, a cooling tunnel and a wrapper that jams every few hours. Then draw it live."
28
+ - "Simulate an offshore gas platform on OPC UA and make the export compressor surge."
29
+ - "Spin up 500 CNC machines on Modbus so I can load-test my historian."
30
+ - "Run a brewery for a simulated month at 1000x and tell me which pump fails first."
31
+ - "Trip a chiller in the data-center cooling plant and show me how fast the server rooms heat up."
32
+ - "Here's our P&ID. Build the plant from it and give me the OPC UA tags."
24
33
 
25
34
  ### Or install it yourself
26
35
 
@@ -56,55 +65,12 @@ docker run --rm -p 127.0.0.1:8080:8080 -p 127.0.0.1:1883:1883 -p 127.0.0.1:4840:
56
65
 
57
66
  The Console is served at `http://127.0.0.1:8080`. The install scripts and the standalone binaries need neither Node.js nor Docker. [All install options](https://miravo.litmus.dev/docs#install-miravo-yourself)
58
67
 
59
- Miravo sends no telemetry. In an interactive terminal, the CLI checks the npm registry for a newer version at most once every 24 hours; `MIRAVO_NO_UPDATE_CHECK=1` turns that off.
60
-
61
- ## Use it with your agent
62
-
63
- The [Miravo skill](https://miravo.litmus.dev/docs/agents) lets your agent build the plant, run it, break machines when you ask, check every endpoint and hand you the connection details. The setup prompt installs it. To add it yourself, run:
68
+ Add the agent skill, which drives the `miravo` CLI:
64
69
 
65
70
  ```shell
66
71
  npx skills add litmusautomation/miravo --skill miravo
67
72
  ```
68
73
 
69
- The skill drives the `miravo` CLI, so [install Miravo](https://miravo.litmus.dev/docs#install-miravo-yourself) first. Then ask in plain language:
70
-
71
- - "Build me a cold-storage warehouse with ammonia compressors, evaporators and dock doors. Serve it on Modbus and draw it live."
72
- - "Start the smart factory on MQTT, jam the press valve and show me everything that broke downstream."
73
- - "Run the commercial building at 100x until a supply fan bearing fails, then tell me which value warned first."
74
-
75
- ## What you can do
76
-
77
- - Start from one of six [built-in templates](https://miravo.litmus.dev/docs/templates) (smart factory, water treatment, commercial building, backup power, district heating, pharma cleanroom), or have your agent build the plant you describe from 19 built-in asset models and the new ones it writes.
78
- - Break it on purpose. Inject a fault and watch it reach the machines around it, or run the clock faster to see months of wear in an afternoon.
79
- - Connect over OPC UA, Modbus TCP, Siemens S7, MQTT and Sparkplug B to the same running factory, and watch each built-in factory run on a live floor in the Console.
80
- - Repeat a run. A fresh run with the same Miravo build, models, template, seed, speed and tick gives the same values, for CI, demos and load tests.
81
- - Connect [Litmus Edge](https://miravo.litmus.dev/docs/integrations/litmus-edge). It is a built-in integration: your agent exports the running factory, so every machine arrives connected and in context.
82
-
83
- ## See a fault spread
84
-
85
- Start the Smart Factory machining line (CNC, unload robot, wash, press, test, packing robot) at 10× speed:
86
-
87
- ```shell
88
- miravo start -t smart-factory --speed 10
89
- ```
90
-
91
- Point your software at it:
92
-
93
- | Protocol | Endpoint |
94
- | ---------- | ------------------------------------------------------------------- |
95
- | OPC UA | `opc.tcp://127.0.0.1:4840` |
96
- | MQTT | `mqtt://127.0.0.1:1883`, topics under `MiravoWorks/smart-factory/#` |
97
- | Modbus TCP | `127.0.0.1:1502`, holding registers |
98
-
99
- Each station publishes `state`, `good_count`, `scrap_count`, cycle times and time spent per state. In a second terminal, jam a valve on the press and watch the line react:
100
-
101
- ```shell
102
- miravo inject press-001 valve_stuck
103
- miravo status --watch
104
- ```
105
-
106
- The press stops. The wash station blocks as its buffer fills, the test station starves, and every station's counters and state times keep the record your OEE logic needs. Sparkplug B starts with `--sparkplug`. Siemens S7 needs `s7` in the template's `protocols` block. See [S7](https://miravo.litmus.dev/docs/protocols/s7) and [Sparkplug B](https://miravo.litmus.dev/docs/protocols/sparkplug).
107
-
108
74
  ## Who it's for
109
75
 
110
76
  - Dashboards, historians, UNS pipelines, MES and OEE apps that need structured live data.
@@ -135,7 +101,7 @@ Miravo is a community-driven open-source project, not a supported Litmus commerc
135
101
 
136
102
  ## Credit
137
103
 
138
- [Amine Amaach](https://www.linkedin.com/in/amine-amaach) designed and built Miravo from the ground up at [Litmus](https://litmus.io), and leads the project. Litmus open-sourced it under the [Litmus Automation GitHub organization](https://github.com/litmusautomation).
104
+ Miravo is the brainchild of [Amine Amaach](https://www.linkedin.com/in/amine-amaach), who architected and built this solution from the ground up here at Litmus. This project stands as a testament to his exceptional technical vision, software design, and problem-solving skills. We are incredibly proud to champion his work and officially open-source it under the Litmus Automation GitHub organization, ensuring his contributions can drive impact across the broader developer community.
139
105
 
140
106
  ## License
141
107