Getting Started
Installation

Installation

The preferred way of installing Lune is using Rokit (opens in a new tab), 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

Follow the installation instructions on the Rokit (opens in a new tab) page.

Installing Lune

Navigate to your project directory using your terminal, and run the following command:

Bash
rokit add lune

Upgrading Lune

When a new version of Lune becomes available, using Rokit will also allow you to easily upgrade to it. Navigate to your project directory using your terminal again, and run the following command:

Bash
rokit update lune

If you prefer to install Lune globally and having it be 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 (opens in a new tab) page.
There are many tools that can install binaries directly from releases, and it is up to you to choose what tool to use when installing here. Lune is compatible with both Foreman (opens in a new tab) and Aftman (opens in a new tab).

Community-maintained

Scoop

Windows users can use Scoop (opens in a new tab) to install Lune.

PowerShell
# 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 (opens in a new tab) to install Lune.

Bash
# Installs latest stable precompiled binary
brew install lune

or

Bash
# 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 (opens in a new tab) repository to install Lune using APT.

⚠️

The APT repository is hosted by the community and is not endorsed by or affiliated with Lune.

AppImage

AppImages are platform independent sandboxed binaries that work out of the box.
Go to the GitHub Actions Page (opens in a new tab), 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 repo; unstable.
  • lune-bin - Installs a precompiled binary from GitHub Release artifacts.

These can be installed with your preferred AUR package manager as such:

Bash
paru -S [PACKAGE_NAME]

or

Bash
yay -S [PACKAGE_NAME]
⚠️

Only one of these AUR packages must be installed at a time in order to prevent conflicts.

Nix

macOS* and Linux users can use Nix (opens in a new tab) to install Lune.

⚠️

*the macOS build is currently broken. Help is wanted debugging it (opens in a new tab).

Imperatively

NixOS

Bash
nix-env -iA nixos.lune

Non NixOS

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

With home-manager (opens in a new tab)

nix
home.packages = with pkgs; [
  lune
];

system-wide NixOS configuration

nix
enviroment.systemPackages = with pkgs; [
  lune
];
Temporarily

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

Bash
nix-shell -p lune
crates.io

Building from source

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

Bash
cargo install lune --locked

Binstall

cargo binstall (opens in a new tab) 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:

Bash
cargo binstall lune

Next Steps

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

  • If you want to write standalone scripts, head over to the Introduction section.
  • If you want to write Lune scripts specifically for Roblox, check out the Roblox section.
Home1 • Hello, Lune!