Skip to main content

Install moon

2 min

The following guide can be used to install moon and integrate it into an existing repository (with or without incremental adoption), or to a fresh repository.

Installing​

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. For convenience, we provide the following scripts to download and install moon.

proto​

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

proto plugin add moon "source:https://raw.githubusercontent.com/moonrepo/moon/master/proto-plugin.toml"
proto install moon

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

.prototools
moon = "1.3.0"
info

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).

Linux, macOS, WSL​

In a terminal that supports Bash, run:

curl -fsSL https://moonrepo.dev/install/moon.sh | bash

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"

Windows​

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.

npm​

moon is also packaged and shipped as a single binary through the @moonrepo/cli npm package. Begin by installing this package at the root of the repository.

yarn add --dev @moonrepo/cli
info

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 it.

Other​

moon can also be downloaded and installed manually, by downloading an asset from https://github.com/moonrepo/moon/releases. Be sure to rename the file after downloading, and apply the executable bit (chmod +x) on macOS and Linux.

Upgrading​

If using proto, moon can be upgraded using the following command:

proto install moon --pin

Otherwise, moon can be upgraded with the moon upgrade command. However, this will only upgrade moon if it was installed in ~/.moon/bin.

moon upgrade

Otherwise, you can re-run the installers above and it will download, install, and overwrite with the latest version.

Canary releases​

moon supports canary releases, which are built and published for every commit to our development branches. These releases will include features and functionality that have not yet landed on master. When using a canary release, you'll need to download and execute the binaries manually:

  • Using our npm package @moonrepo/cli under the canary tag. Releases are versioned by date.
  • From a GitHub prerelease using the canary tag. This tag always represents the latest development release.

Nightly releases​

moon supports nightly releases, which are built and published once a day from the latest commit on master. When using a nightly release, you'll need to download and execute the binaries manually.

  • Using our npm package @moonrepo/cli under the nightly tag. Releases are versioned by date.
  • From a GitHub prerelease using the nightly tag. This tag always represents the latest stable release.

Next steps​

Setup workspace