Installation

The preferred way of installing Lune is using Rokit, a toolchain manager for Roblox projects. Rokit can manage your installed version of Lune and other ecosystem tools, and allows you to easily upgrade to newer versions as they become available.

Installing Rokit
Section titled “Installing Rokit”

Follow the installation instructions on the Rokit page.
Installing Lune
Section titled “Installing Lune”

Navigate to your project directory using your terminal, and run the following command:
Terminal
```
rokit add lune
```
Upgrading Lune
Section titled “Upgrading Lune”

When a new version of Lune becomes available, Rokit makes it easy to upgrade. Navigate to your project directory using your terminal again, and run the following command:
Terminal
```
rokit update lune
```

If you prefer to install Lune globally and have it accessible on your entire system, instead of only in a specific project, you can do this with Rokit as well. Just add the --global option to the end of the commands above.

Other Installation Options

Using GitHub Releases

You can download pre-built binaries for most systems directly from the GitHub Releases page. There are many tools that can install binaries directly from releases, and it’s up to you to choose what tool to use. Lune is compatible with both Foreman and Aftman.

Community-maintained

Scoop

Windows users can use Scoop to install Lune.

# Add the bucket
scoop bucket add lune https://github.com/CompeyDev/lune-packaging.git

# Install the package
scoop install lune

Homebrew

macOS and Linux users can use Homebrew to install Lune.

# Installs latest stable precompiled binary
brew install lune

# Builds from latest stable source
brew install lune --build-from-source

APT

APT is a package manager for Debian-based Linux distributions that uses dpkg to install packages. Follow the instructions at the unofficial lune-packaging repository to install Lune using APT.

AppImage

AppImages are platform-independent sandboxed binaries that work out of the box. Go to the GitHub Actions Page, and download the artifact suitable for your architecture from the build artifacts.

AUR (Arch User Repository)

There are a number of packages available on the AUR:

lune - Builds from the latest stable release source
lune-git - Builds from the latest commit in the repository (unstable)
lune-bin - Installs a precompiled binary from GitHub Release artifacts

These can be installed with your preferred AUR package manager:

paru -S [PACKAGE_NAME]

yay -S [PACKAGE_NAME]

Nix

macOS* and Linux users can use Nix to install Lune.

Imperatively

NixOS

nix-env -iA nixos.lune

Non-NixOS

nix-env -iA nixpkgs.lune
# If you are using flakes
nix profile install nixpkgs#lune

Declaratively

With home-manager

home.packages = with pkgs; [
  lune
];

System-wide NixOS configuration

environment.systemPackages = with pkgs; [
  lune
];

Temporarily

You can temporarily use Lune in your shell. This is useful to try out Lune before deciding to permanently install it.

nix-shell -p lune

Using crates.io

Building from source

Building and installing from source requires the latest version of Rust & Cargo to be installed on your system. Once installed, run the following command in your terminal:

cargo install lune --locked

Binstall

cargo binstall provides a simple mechanism for installing Rust binaries from crates.io without compiling from source (unlike cargo install). Lune is packaged in a binstall-compatible way.

With binstall installed and in your path, run:

cargo binstall lune

Next Steps

Congratulations! You’ve installed Lune and are now ready to write your first script.

A great place to continue reading is the Lune Book, which is also part of the official Lune documentation, and will give you a guided and comprehensive introduction to Lune.

Or, if you want to dive right into specific resources, check out the API reference in the sidebar.