Getting Started
Installation

Installation

The preferred way of installing Lune is using Aftman (opens in a new tab).

Install Aftman, and run this command in your terminal to add lune to an aftman.toml file in the current directory, or create one if it does not exist:

Bash
aftman add lune-org/lune

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.

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.

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!