Mage-OS Installer

April 28, 2026 ยท View on GitHub

Get up & running with Mage-OS in minutes. If you have DDEV or Warden installed already, this tool will automatically detect and configure them for you.

Features

  • Automatically detects available development environments
  • Configures services (OpenSearch, Redis, RabbitMQ, Varnish) out of the box

Supported environments

EnvironmentSite URL
DDEVhttps://{project}.test
Wardenhttps://app.{project}.test

Prerequisites

  • Docker installed and running
  • At least one supported environment installed (DDEV or Warden)

Installation

Download the latest binary for your platform from the releases page.

macOS (Apple Silicon)

sudo curl -sL -o /usr/local/bin/mage-os-install https://github.com/mage-os-lab/mage-os-installer/releases/latest/download/mage-os-install_darwin_arm64
sudo chmod +x /usr/local/bin/mage-os-install

macOS (Intel)

sudo curl -sL -o /usr/local/bin/mage-os-install https://github.com/mage-os-lab/mage-os-installer/releases/latest/download/mage-os-install_darwin_amd64
sudo chmod +x /usr/local/bin/mage-os-install

Linux (x86_64)

sudo curl -sL -o /usr/local/bin/mage-os-install https://github.com/mage-os-lab/mage-os-installer/releases/latest/download/mage-os-install_linux_amd64
sudo chmod +x /usr/local/bin/mage-os-install

Linux (ARM64)

sudo curl -sL -o /usr/local/bin/mage-os-install https://github.com/mage-os-lab/mage-os-installer/releases/latest/download/mage-os-install_linux_arm64
sudo chmod +x /usr/local/bin/mage-os-install

Windows

Download mage-os-install_windows_amd64.exe (or mage-os-install_windows_arm64.exe) from the releases page and add the directory to your PATH.

Via Go

go install github.com/mage-os-lab/mage-os-installer@latest

Usage

Run the installer from the directory where you want your project:

mage-os-install

The installer will walk you through:

  1. Project name -- defaults to the current directory name
  2. Install directory -- where to create the project
  3. Environment selection -- pick DDEV or Warden (auto-selected if only one is available)
  4. Admin credentials -- configure the Mage-OS admin user
  5. Command review -- inspect the setup:install flags before running
  6. Installation -- watch progress in real time

Wishlist

  • Save & reuse a config profile (~/.mage-os-install.yaml) so re-running skips prompts.
  • Custom locale / currency / timezone defaults (instead of always en_US).
  • Non-interactive / scripted mode via flags or a config file (useful for CI and demos).