Option 1 — Recommended

macOS & Linux

Install the mimir CLI with one command:

terminal

$ curl -fsSL https://tanuj24.github.io/mimir/install.sh | sh

Then start your local cloud:

terminal

$ mimir start

Open http://localhost:8080 for the console. Your AWS CLI, SDKs and apps talk to http://localhost:4566 with access key mimir, secret key mimir, region us-east-1.

Command	What it does
`mimir start`	Starts the local cloud (first run downloads the image, ~1 GB).
`mimir stop`	Stops the container. All resources are kept.
`mimir status`	Shows whether Mimir is running and on which ports.
`mimir logs`	Streams container logs.
`mimir restart`	Stop and start again — resources are kept.
`mimir update`	Pulls the latest image and restarts on it.
`mimir open`	Opens the web console in your browser.
`mimir doctor`	Checks your container runtime, ports and setup, and suggests fixes.
`mimir uninstall --purge`	Removes Mimir; `--purge` also deletes the `mimir-data` volume and every stored resource.

mimir update never loses resources. Updates are lossless — your buckets, tables, functions, databases and every other resource are always preserved across updates.

Option 2

Docker — any platform, including Windows

If you already have Docker, run the image directly:

terminal

$ docker run -d --name mimir \
  -p 8080:80 -p 4566:4566 -p 5500-5524:5500-5524 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /tmp/mimir-glue:/tmp/mimir-glue \
  tanujsoni027/mimir-aws:latest

The web console is at http://localhost:8080 and the AWS-compatible endpoint at http://localhost:4566. Credentials: access key mimir, secret key mimir, region us-east-1.

State persists automatically. Mimir stores everything in a mimir-data Docker volume it manages for you — no volume flags needed. Your resources survive stops, container removal and image updates.

Option 3

Homebrew

Coming soon. Until then, use the install script above — it does the same thing in one command.

Before you start

Requirements

A container runtime Docker Desktop, Docker Engine, or colima. That's the only prerequisite for every install method.

~1 GB first download The image is multi-arch (linux/amd64 + linux/arm64, Apple Silicon native).

No AWS account, ever Core services work offline once pulled; container-backed engines (Glue, RDS, EKS) download their engine images on first use.

Maintenance

Updating & uninstalling

Updating

CLI users: run mimir update. It is lossless — resources are always preserved.

Docker users: pull the new image and recreate the container. Because state lives in the mimir-data volume, nothing is lost:

terminal

$ docker pull tanujsoni027/mimir-aws:latest
docker rm -f mimir
docker run -d --name mimir \
  -p 8080:80 -p 4566:4566 -p 5500-5524:5500-5524 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /tmp/mimir-glue:/tmp/mimir-glue \
  tanujsoni027/mimir-aws:latest

Uninstalling

mimir uninstall removes the CLI and container but keeps the mimir-data volume, so a later reinstall finds your resources intact. Add --purge to also delete the volume and every stored resource.

When things break

Troubleshooting

Start with the built-in checkup:

terminal

$ mimir doctor

It verifies your container runtime, port availability and setup, and tells you exactly what to fix.

Port conflicts

If something already uses port 8080 or 4566, set MIMIR_CONSOLE_PORT and/or MIMIR_EDGE_PORT before starting:

terminal

$ MIMIR_CONSOLE_PORT=9090 MIMIR_EDGE_PORT=4567 mimir start

Data endpoints live in a dedicated 5500–5550 range (RDS, ElastiCache and Neptune via the published 5500–5524 ports; the rest bind automatically), so they won't clash with a local Redis, Postgres or Elasticsearch.

Still stuck?

Open an issue at github.com/tanuj24/mimir/issues — include the output of mimir doctor and mimir logs.