Install the CLI

Shell installer

curl -LsSf https://lumis.sh/install.sh | sh

curl -LsSf https://lumis.sh/0.5.1/install.sh | sh

The installers download the matching archive from GitHub Releases and verify its published SHA-256 checksum before unpacking it. The default install directory is ~/.local/bin.

Set LUMIS_INSTALL_DIR to choose another directory. Set LUMIS_NO_MODIFY_PATH=1 to install without changing PATH.

Package managers

Homebrew:

brew trust --tap leandrocp/lumis
brew tap leandrocp/lumis
brew install lumis

Download a release binary through Cargo without compiling Lumis:

cargo binstall lumis-cli

Use the GitHub release through mise's GitHub backend. The options select only CLI releases and their platform archives from this multi-package repository:

mise use 'github:leandrocp/lumis[version_prefix=cargo-lumis-cli/v,matching_regex=^lumis-(aarch64|x86_64)-]@latest'

From npm:

npm install -g @lumis-sh/cli

From crates.io:

cargo install lumis-cli

Building from source

Download a source archive from a cargo-lumis-cli/v* release and extract it. From the extracted repository root, run:

cargo build --release --locked -p lumis-cli
cargo test --release --locked -p lumis-cli

The executable is target/release/lumis, or target/release/lumis.exe on Windows. Building requires Rust and a C/C++ toolchain. Use the MSVC toolchain on Windows.

CLI releases are tagged cargo-lumis-cli/v<version>. Other tags in the repository belong to other packages.