Getting Started

Installation

Lithos ships as a single self-contained binary. Pick whichever install path matches how the rest of your toolchain is managed.

Most Roblox projects already use Foreman (opens in a new tab) to pin Rojo and friends. Add Lithos to the same foreman.toml so every machine, local or CI, runs the same version.

Install options

Option	When to use it
Foreman	You want one pinned version across local and CI. Recommended.
Direct download	You just want the binary on your `PATH`.
Cargo	You're hacking on Lithos itself.

Install with Foreman (recommended)

Add Lithos to foreman.toml:

foreman.toml

[tools]
lithos = { source = "siriuslatte/lithos", version = "<version>" }

Pick the current version from the releases (opens in a new tab) page, then run:

foreman install
lithos --version

If you need Foreman itself, see Getting started → Install Lithos.

Manually download from releases (simplest)

Grab the latest build from github.com/siriuslatte/lithos/releases (opens in a new tab) and drop the binary somewhere on your PATH.

# Extract lithos.exe into a folder already on your PATH, e.g.
# C:\Tools\lithos\, then verify:
lithos --version

Build from source with Cargo

You need a recent Rust toolchain. From a clone of the repo:

cargo install --path src/lithos
lithos --version

⚠️

Source builds skip the cross-platform checks the release pipeline runs. Stick to Foreman or release binaries for anything you ship.

Next steps

Getting Started Authentication