Installation

The entirety of moon is packaged and shipped as a single binary. It works on all major operating systems and does not require any external dependencies.

System Requirements

moon supports the following platforms:

Operating System	Architecture	Target
macOS 64-bit	ARM	`aarch64-apple-darwin`
Linux 64-bit	Intel GNU	`x86_64-unknown-linux-gnu`
Linux 64-bit	Intel musl	`x86_64-unknown-linux-musl`
Linux 64-bit	ARM GNU	`aarch64-unknown-linux-gnu`
Linux 64-bit	ARM musl	`aarch64-unknown-linux-musl`
Windows 64-bit	Intel	`x86_64-pc-windows-msvc`

Installation Methods

proto (recommended)
npm
Linux, macOS, WSL
Windows
Manual Download

moon can be installed and managed in proto’s toolchain. This will install moon to ~/.proto/tools/moon and make the binary available at ~/.proto/bin.

proto install moon

The version of moon can be pinned on a per-project basis using the .prototools config file:

.prototools

moon = "2.0.0"

We suggest using proto to manage moon (and other tools), as it allows for multiple versions to be installed and used. The other installation options only allow for a single version (typically the last installed).

moon is packaged as a single binary through the @moonrepo/cli npm package. Install it at the root of your repository:

npm install --save-dev @moonrepo/cli

If installing with Bun, you’ll need to add @moonrepo/cli as a trusted dependency.

When a global moon binary is executed, and the @moonrepo/cli binary exists within the repository, the npm package version will be executed instead. We do this because the npm package denotes the exact version the repository is pinned to.

In a terminal that supports Bash, run:

bash <(curl -fsSL https://moonrepo.dev/install/moon.sh)

This will install moon to ~/.moon/bin. You’ll then need to set PATH manually in your shell profile:

export PATH="$HOME/.moon/bin:$PATH"

In PowerShell or Windows Terminal, run:

irm https://moonrepo.dev/install/moon.ps1 | iex

This will install moon to ~\.moon\bin and prepend to the PATH environment variable for the current session. To persist across sessions, update PATH manually in your system environment variables.

If you are using Git Bash on Windows, you can run the Unix installation command instead.

moon can be downloaded and installed manually by downloading an asset from GitHub releases.

Download the binary

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

Rename the file

Rename the downloaded file to moon (or moon.exe on Windows).

Make it executable

On macOS and Linux, apply the executable bit:

chmod +x moon

Move to PATH

Move the binary to a directory in your PATH environment variable.

Verify Installation

After installation, verify that moon is available by checking its version:

moon --version

You should see output similar to:

moon 2.0.0

Upgrading moon

proto
npm
Shell Script

If using proto, moon can be upgraded using:

proto install moon --pin

Update the @moonrepo/cli package version in your package.json:

npm install --save-dev @moonrepo/cli@latest

moon can be upgraded with the moon upgrade command if it was installed in ~/.moon/bin:

moon upgrade

Otherwise, you can re-run the installation scripts and they will download, install, and overwrite with the latest version.

Next Steps

Setup Workspace

Initialize moon in your repository and configure your workspace

Get Started

Core Concepts

Guides

Configuration

Installation

System Requirements

Installation Methods

Verify Installation

Upgrading moon

Next Steps

Setup Workspace

Build docs developers (and LLMs) love

Get Started

Core Concepts

Guides

Configuration

​System Requirements

​Installation Methods

​Verify Installation

​Upgrading moon

​Next Steps

Setup Workspace

Build docs developers (and LLMs) love

System Requirements

Installation Methods

Verify Installation

Upgrading moon

Next Steps