Installation

Miravo runs as a single process. Pick the method that fits your environment.

Docker (recommended)

Pull and run the multi-arch image (linux/amd64 and linux/arm64). Port 1883 is the MQTT broker and port 8080 is the admin API and web console:

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

The image is also available on GitHub Container Registry:

docker run --rm -p 1883:1883 -p 8080:8080 ghcr.io/amine-amaach/miravo:latest

Pin a specific version:

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

bunx

Requires Bun installed locally:

One-shot

bunx miravo start

Global install

bun install -g miravo
miravo start

Standalone Binary

Download a pre-built binary from the GitHub Releases page:

Platform	Architecture	File
Linux	x64	miravo-linux-x64.tar.gz
Linux	arm64	miravo-linux-arm64.tar.gz
macOS	x64	miravo-darwin-x64.tar.gz
macOS	arm64	miravo-darwin-arm64.tar.gz
Windows	x64	miravo-windows-x64.zip

tar xzf miravo-linux-x64.tar.gz
chmod +x miravo
./miravo start

The standalone binary embeds all built-in content. No runtime dependencies required.

From Source

git clone https://github.com/amine-amaach/miravo.git
cd miravo
bun install
bun run packages/cli/src/index.ts start

Verify

After starting, confirm data is flowing:

Admin health check:

curl http://127.0.0.1:8080/healthz

Subscribe to MQTT data:

mosquitto_sub -h 127.0.0.1 -t '#' -v