Installation

larvae ships as a single binary with no runtime dependencies. Pick one of the routes below, they all end with a larvae you can run.

Add it to a project with lpm

lpm is the Luau package manager. Adding larvae as a project tool pins it for everyone who clones the repo.

lpm tool add larvae

This is the route to prefer for real projects, since the tool version travels with the project rather than with each machine.

Run it once with lpx

lpx fetches and runs larvae without installing anything.

lpx larvae

Good for trying larvae on a project before committing to it, or for a one off run in CI. Nothing is left on the machine afterwards.

Build from source

cargo install larvae

That pulls the published crate from crates.io, so it needs no checkout.

To build from a clone instead, ex: to try an unreleased change, point cargo at the path:

cargo install --path .

Prebuilt binaries

Release builds are attached to the GitHub releases page. Assets are named larvae-{os}-{arch}, with .exe appended on Windows.

Download the asset for your platform, mark it executable if your OS needs that, and move it somewhere on your PATH. Or let larvae do the moving for you, see below.

Putting larvae on PATH

larvae self install copies the running binary to ~/.larvae/bin/larvae, so run it with the binary you just downloaded or built.

larvae self install

On Windows it puts the directory on your PATH for real, writing the user Path in the registry and broadcasting the change so newly opened terminals pick it up. Nothing further to do.

On unix it prints the line for your shell profile instead:

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

That asymmetry is deliberate. Editing someone's shell profile without asking is rude, so unix leaves the last step to you.

Running self install twice is safe. It also warns when another tool already manages the larvae binary, because a second copy can shadow the first on PATH and leave you running a version you did not expect.

The four self subcommands

self install, self update, self uninstall and self code are separate alternatives, not steps to run in order. You pick the one that matches what you want to do right now.

self update

Checks GitHub releases, downloads the newer build, and swaps it in.

larvae self update

It honors GITHUB_TOKEN for the releases API, which matters if you hit rate limits on a shared runner. When there is nothing newer it says larvae is already up to date and exits.

It only updates the copy self install made. If rokit, aftman, foreman, lpm or cargo owns your binary, it refuses and points you at that manifest instead, since overwriting a pinned tool leaves the manifest and the bytes on disk disagreeing. Bump the version where the pin lives, or pass --force if you really want the swap.

larvae self update --force

self uninstall

Removes ~/.larvae.

larvae self uninstall

It prompts with Remove <dir>? first, and the default answer is no, so pressing enter cancels.

self code

Sets up your editor for larvae.toml: completion, hover docs, and the valid values for every key.

larvae self code

It is a one time step per machine, not part of installing the binary, which is why it is its own subcommand. What it writes and why is covered in editor setup.

Verify the install

larvae

With no arguments larvae prints its logo beside the help text. See the CLI reference for every command and flag.

Next steps

Head to the quick start to go from a Rojo project to native string requires. Config lives in larvae.toml, documented in the configuration reference, though a plain Rojo project with .luaurc aliases needs no config at all.