Quick Start
Install Miravo, start an environment, and connect your system.
Install Miravo. Start the default environment. Connect your system.
Install Miravo
Use the install script. It installs the standalone binary into ~/.miravo/bin.
curl -fsSL https://miravo.dev/install | bashInstall from your package manager. Requires Node.js.
npm install -g miravoOr run without installing: npx miravo, pnpm dlx miravo, bunx miravo, yarn dlx miravo.
docker run --rm -p 1883:1883 -p 8080:8080 amineamaach/miravo:latestAlso available on GitHub Container Registry as ghcr.io/amine-amaach/miravo:latest. For Compose stacks, volumes, and health probes, see Docker deployment.
Download a pre-built archive from GitHub Releases and extract:
tar xzf miravo-<version>-linux-x64.tar.gz
chmod +x miravo
./miravo startThe install script uses linux-x64, linux-arm64, darwin-x64, and darwin-arm64 archives.
No Node.js or Docker required.
Recommended: use WSL
On Windows, run Miravo inside WSL and install with the Linux install script.
npm install -g miravodocker run --rm -p 1883:1883 -p 8080:8080 amineamaach/miravo:latestWindows standalone archives are not installed by the script. Use WSL for script installs, or use Docker, npm, or the Windows archive manually.
The install script supports Linux and macOS only.
Start an environment
miravo startRun in the background when you need the shell back.
miravo start -dFlags, detached mode, and dry-run: miravo start.
Open the Console
http://127.0.0.1:8080 in your browser.admin / admin. Set a new password when prompted.The Fleet view shows live numbers for the default smart-factory
environment.
How to know it worked
Verified
- MQTT — subscribe to a live topic and watch the JSON payload change.
MQTT check. - OPC UA —
browse from
Root/Objectsand confirm the plant hierarchy appears. OPC UA check. - Modbus TCP — read a holding register and confirm the value is live. Modbus check.
Where to go next
What is Miravo?
Scope, limits, and fit.
CLI reference
Start, inspect, and automate from the shell.
Choose an environment
Built-in environments by industrial context.
Miravo Core
Models, runtime, and state.
Was this page useful?
Last updated on
Miravo