Miravo

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 | bash

Install from your package manager. Requires Node.js.

npm install -g miravo

Or run without installing: npx miravo, pnpm dlx miravo, bunx miravo, yarn dlx miravo.

docker run --rm -p 1883:1883 -p 8080:8080 amineamaach/miravo:latest

Also 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 start

The 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 miravo
docker run --rm -p 1883:1883 -p 8080:8080 amineamaach/miravo:latest

Windows 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 start

Run in the background when you need the shell back.

miravo start -d

Flags, detached mode, and dry-run: miravo start.

Open the Console

Open http://127.0.0.1:8080 in your browser.
Log in with 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/Objects and 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

Was this page useful?

Last updated on