docs/Getting started/Install the CLI

Install the CLI

The Flareo CLI runs on Linux and macOS, on both x86_64 and arm64. Windows works under WSL2; we don't yet ship a native Windows binary.

Build from source (current path)

Requires Rust 1.80 or newer:

git clone https://github.com/Yolo1105/flareo.git
cd flareo/packages/cli
cargo build --release
./target/release/flareo --version

Optional: set FLAREO_GITHUB_CLIENT_ID at build time to the public client ID of a GitHub OAuth App with Device Flow enabled, so flareo login works against your account:

FLAREO_GITHUB_CLIENT_ID=<your-oauth-app-id> cargo build --release

Check it worked:

./target/release/flareo --version

Signed release binaries

Signed release archives will be published on GitHub Releases once the release workflow runs. Until those artifacts exist, building from source is the supported install path. Do not pipe a remote install script into a shell.

Next steps

Once the CLI is built, verify your first module.