Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

Pre-built binaries are available for Linux (x86_64, ARM64), macOS (ARM64), and Windows (x86_64) on the releases page.

macOS / Linux

curl -fsSL https://github.com/EvilBit-Labs/ruley/releases/latest/download/ruley-installer.sh | sh

Windows

powershell -ExecutionPolicy Bypass -c "irm https://github.com/EvilBit-Labs/ruley/releases/latest/download/ruley-installer.ps1 | iex"

Homebrew

brew install EvilBit-Labs/tap/ruley

Cargo (crates.io)

cargo install ruley

This builds from source with default features (Anthropic, OpenAI, TypeScript compression).

With All Features

cargo install ruley --all-features

Minimal Install

cargo install ruley --no-default-features --features anthropic

cargo-binstall

If you have cargo-binstall installed:

cargo binstall ruley

Building from Source

git clone https://github.com/EvilBit-Labs/ruley.git
cd ruley
cargo build --release

The binary will be at ./target/release/ruley.

System Requirements

  • Operating system: Linux (x86_64, ARM64), macOS (ARM64), Windows (x86_64)
  • Rust (build from source only): 1.91 or newer (see rust-version in Cargo.toml)
  • Network: Required for LLM API calls (except Ollama which runs locally)

Feature Flags

ruley uses Cargo feature flags to control which LLM providers and compression languages are compiled in:

FeatureDescriptionDefault
anthropicAnthropic Claude providerYes
openaiOpenAI GPT providerYes
ollamaOllama local model providerNo
openrouterOpenRouter multi-model providerNo
all-providersAll LLM providersNo
compression-typescriptTypeScript tree-sitter grammarYes
compression-pythonPython tree-sitter grammarNo
compression-rustRust tree-sitter grammarNo
compression-goGo tree-sitter grammarNo
compression-allAll compression languagesNo

Verifying Releases

All release artifacts are signed via Sigstore using GitHub Attestations:

gh attestation verify <artifact> --repo EvilBit-Labs/ruley

See Release Verification for details.