miravo 0.6.0 → 0.6.2

package/LICENSE

@@ -0,0 +1,199 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to the Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by the Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding any notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. Please also get an
+      information on the current year at http://www.apache.org/licenses/
+
+Copyright 2026 Amine Amaach
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,76 +1,46 @@
-# Miravo
+<p align="center">
+  <img src="https://miravo.dev/miravo-logo.webp" alt="Miravo" width="120" />
+</p>
 
-Industrial environment platform. Canonical asset models, multi-protocol output, structured plant topology.
+<p align="center">Industrial environments as code.</p>
 
-Miravo simulates industrial assets with realistic physics -- correlated tags, lifecycle degradation, cascading faults -- and projects them over MQTT, OPC UA, Modbus TCP, and more from a single canonical asset model.
+<p align="center"><strong>Miravo</strong> is an open-source industrial modeling and simulation platform. Describe the plant once. Miravo runs it with real topology, lifecycle wear, and cascading faults — and speaks MQTT, OPC UA, and Modbus TCP at the same time, the way a real plant does.</p>
 
-```
-MiravoWorks/smart-factory
-├── production/line-1
-│   └── pump-001
-│       ├── discharge_pressure   → 2.91
-│       ├── flow_rate            → 43.7
-│       └── vibration_axial      → 1.82
-└── utilities/compressed-air
-    └── compressor-001
-        └── header_pressure      → 7.8
-```
+<p align="center">
+  <img src="https://miravo.dev/console-screenshot.png" alt="Miravo Console" width="80%" />
+</p>
 
-## Install
+---
 
-```bash
-# bunx (requires Bun — https://bun.sh)
-bunx miravo start
+## Quickstart
 
-# Docker
-docker run --rm -p 1883:1883 -p 8080:8080 amineamaach/miravo:latest
+Install Miravo on Linux/macOS.
 
-# Standalone binary (no runtime needed)
-# Download from https://github.com/amine-amaach/miravo/releases
-./miravo start
+```shell
+curl -fsSL https://miravo.dev/install | bash
 ```
 
-## Quick Start
-
-```bash
-# List available templates
-miravo templates list
-
-# Start a simulation (interactive template picker if TTY)
-miravo start
-
-# Start with a specific template
-miravo start --template smart-factory
-
-# Deterministic replay
-miravo start --seed 42
-
-# Faster simulated time
-miravo start --speed 10 --tick 500
+```shell
+npm install -g miravo
 ```
 
-Connect any MQTT client to `localhost:1883` and subscribe to `#` to see the data.
-
-## 3-Command Demo
+Use Node.js >= 18.
 
-```bash
-miravo start -d --name my-sim     # Start in daemon mode
-miravo inject pump-001 cavitation  # Inject a fault at runtime
-miravo ps                          # List running simulations
-```
+[Full install options: Docker, Windows guidance, and standalone binaries.](https://miravo.dev/docs#1-install-miravo)
 
-## Documentation
+Get started with the [`Smart Factory`](https://miravo.dev/docs/environments/smart-factory) environment — the Console opens at `http://127.0.0.1:8080`.
 
-For the full command reference, all options, environment variables, and advanced usage, visit **[miravo.dev/docs/cli-reference](https://miravo.dev/docs/cli-reference/)**.
+```shell
+miravo start
+```
 
-| Topic | Link |
-| --- | --- |
-| CLI Reference | [miravo.dev/docs/cli-reference](https://miravo.dev/docs/cli-reference/) |
-| Environment Variables | [miravo.dev/docs/environment-variables](https://miravo.dev/docs/environment-variables/) |
-| Docker | [miravo.dev/docs/docker](https://miravo.dev/docs/docker/) |
-| Twin Models | [miravo.dev/docs/twin-models](https://miravo.dev/docs/twin-models/) |
-| Built-in Content | [miravo.dev/docs/built-in-content](https://miravo.dev/docs/built-in-content/) |
+## Docs
 
-## License
+- [**Documentation**](https://miravo.dev/docs)
+- [**Core concepts**](https://miravo.dev/docs/core/concepts)
+- [**Twin models**](https://miravo.dev/docs/core/twin-models)
+- [**CLI reference**](https://miravo.dev/docs/cli/reference)
+- [**Protocols**](https://miravo.dev/docs/protocols) — MQTT, OPC UA, Modbus TCP
+- [**Platforms**](https://miravo.dev/docs/platforms) — Litmus Edge today; Ignition, AWS IoT, Azure IoT in the works
 
-[Apache 2.0](https://github.com/amine-amaach/miravo/blob/main/LICENSE)
+This repository is licensed under the [Apache-2.0 License](LICENSE).

package/bin/miravo.js

@@ -0,0 +1,84 @@
+#!/usr/bin/env node
+
+const fs = require("node:fs");
+const path = require("node:path");
+const { spawnSync } = require("node:child_process");
+
+const PLATFORM_PACKAGES = new Map([
+  ["linux/x64", "@miravo/cli-linux-x64"],
+  ["linux/arm64", "@miravo/cli-linux-arm64"],
+  ["darwin/x64", "@miravo/cli-darwin-x64"],
+  ["darwin/arm64", "@miravo/cli-darwin-arm64"],
+  ["win32/x64", "@miravo/cli-windows-x64"],
+]);
+
+function resolveBinaryName(platform) {
+  return platform === "win32" ? "miravo.exe" : "miravo";
+}
+
+function detectMuslLibc(options = {}) {
+  const fsModule = options.fsModule || fs;
+  const spawnSyncFn = options.spawnSyncFn || spawnSync;
+  try {
+    if (fsModule.existsSync("/etc/alpine-release")) return true;
+  } catch {}
+  try {
+    // Avoid /lib scanning: glibc hosts can also have musl loaders installed.
+    const result = spawnSyncFn("ldd", ["--version"], { encoding: "utf8" });
+    const combinedOutput = `${result?.stdout || ""}\n${result?.stderr || ""}`;
+    if (/\bmusl\b/i.test(combinedOutput)) return true;
+  } catch {}
+  return false;
+}
+
+function fail(message) {
+  process.stderr.write(`miravo: ${message}\n`);
+  process.exit(1);
+}
+
+function main() {
+  const platform = process.platform;
+  const arch = process.arch;
+  const packageName = PLATFORM_PACKAGES.get(`${platform}/${arch}`);
+
+  if (!packageName) {
+    fail(
+      `unsupported platform ${platform}/${arch}. Supported: linux/x64, linux/arm64, darwin/x64, darwin/arm64, win32/x64. Use the install script, Docker, or a standalone archive.`,
+    );
+  }
+
+  if (platform === "linux" && detectMuslLibc()) {
+    fail(
+      `Linux musl (for example Alpine) is unsupported for package-manager installs. Use https://miravo.dev/install, Docker, or a standalone archive.`,
+    );
+  }
+
+  let pkgJsonPath;
+  try {
+    pkgJsonPath = require.resolve(`${packageName}/package.json`, { paths: [__dirname] });
+  } catch {
+    fail(
+      `${packageName} is not installed. Reinstall with optional dependencies enabled (example: npm install miravo --include=optional). If you use a corporate proxy, allow @miravo/* packages.`,
+    );
+  }
+
+  const bin = path.join(path.dirname(pkgJsonPath), resolveBinaryName(platform));
+  if (!fs.existsSync(bin)) {
+    fail(`${packageName} is incomplete: missing binary at ${bin}. Reinstall miravo.`);
+  }
+
+  const result = spawnSync(bin, process.argv.slice(2), {
+    stdio: "inherit",
+    windowsHide: false,
+  });
+  if (result.error) {
+    fail(`failed to spawn ${bin}: ${result.error.message}`);
+  }
+  process.exit(typeof result.status === "number" ? result.status : 1);
+}
+
+if (require.main === module) {
+  main();
+}
+
+module.exports = { main, resolveBinaryName, detectMuslLibc };

package/package.json

@@ -1,51 +1,35 @@
 {
   "name": "miravo",
-  "version": "0.6.0",
-  "type": "module",
-  "description": "Industrial environment platform with canonical asset models and MQTT + OPC UA protocol adapters",
+  "version": "0.6.2",
+  "description": "Industrial environment platform — Node launcher that runs the platform-specific Miravo binary.",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "https://github.com/amine-amaach/miravo.git",
-    "directory": "packages/cli"
+    "url": "git+https://github.com/amine-amaach/miravo.git",
+    "directory": "packages/cli-launcher"
   },
-  "publishConfig": {
-    "access": "public"
+  "bin": {
+    "miravo": "bin/miravo.js"
   },
-  "keywords": [
-    "iiot",
-    "digital-twin",
-    "mqtt",
-    "simulator",
-    "uns",
-    "industrial-iot"
+  "files": [
+    "bin/",
+    "README.md",
+    "LICENSE"
   ],
   "engines": {
-    "bun": ">=1.0.0"
+    "node": ">=18"
   },
-  "bin": {
-    "miravo": "./src/index.ts"
+  "optionalDependencies": {
+    "@miravo/cli-linux-x64": "0.6.2",
+    "@miravo/cli-linux-arm64": "0.6.2",
+    "@miravo/cli-darwin-x64": "0.6.2",
+    "@miravo/cli-darwin-arm64": "0.6.2",
+    "@miravo/cli-windows-x64": "0.6.2"
   },
-  "files": [
-    "src/",
-    "console-dist/"
-  ],
-  "dependencies": {
-    "@clack/prompts": "^1.1.0",
-    "@miravo/core": "0.6.0",
-    "@miravo/modbus": "0.6.0",
-    "@miravo/mqtt": "0.6.0",
-    "@miravo/opcua": "0.6.0",
-    "@miravo/shared": "0.6.0",
-    "commander": "^13.0.0",
-    "consola": "^3.4.0",
-    "mqtt": "^5.15.0",
-    "yaml": "^2.8.1",
-    "zod": "^3.24.0"
+  "exports": {
+    "./package.json": "./package.json"
   },
-  "devDependencies": {
-    "@miravo/console": "0.0.0",
-    "node-opcua-client": "^2.169.0",
-    "node-opcua-variant": "^2.169.0"
+  "publishConfig": {
+    "access": "public"
   }
 }

package/console-dist/assets/activity-DsWeRq4h.js

@@ -1 +0,0 @@
-import{t as e}from"./createLucideIcon-Bwxw859K.js";var t=e(`activity`,[[`path`,{d:`M22 12h-2.48a2 2 0 0 0-1.93 1.46l-2.35 8.36a.25.25 0 0 1-.48 0L9.24 2.18a.25.25 0 0 0-.48 0l-2.35 8.36A2 2 0 0 1 4.49 12H2`,key:`169zse`}]]);export{t};