Installation

This page covers the operator install paths for Mullgate itself.

Requirements

• Node.js 22 or newer
• a supported package manager or shell for the installer script
• Linux if you want the full shipped runtime behavior today

macOS and Windows can install the CLI and use setup, config, path, status, and doctor surfaces truthfully, but the current multi-route runtime remains Linux-first.

Recommended install path

Use the checked-in installer for the fastest normal path.

Linux or macOS

curl -fsSL https://raw.githubusercontent.com/Microck/mullgate/main/scripts/install.sh | sh
mullgate --help

Windows

irm https://raw.githubusercontent.com/Microck/mullgate/main/scripts/install.ps1 | iex
mullgate --help

Package-manager install

If you prefer to install it directly from npm:

npm install -g mullgate
pnpm add -g mullgate
bun add -g mullgate

Verify the install

mullgate --help
mullgate config path

Use mullgate config path to confirm the active config, state, cache, and runtime paths on your current platform.

Choose your first run

Interactive setup

If you want Mullgate to guide you through account, credentials, routes, bind posture, and optional HTTPS settings:

mullgate setup

Non-interactive setup

If you want automation, CI-style setup, or a repeatable server bootstrap:

mullgate setup --non-interactive

Start from .env.example if you want a reference list of supported setup inputs.

Next step

Continue with Quickstart for the first end-to-end workflow.