Installation
Lime is distributed as source. Build it once with Cargo, then add the
resulting binary to your PATH.
Prerequisites
- A working Rust toolchain. The repository pins a specific toolchain
via
rust-toolchain.toml, whichrustupwill install for you on first build. - An API key for at least one provider:
- OpenAI —
OPENAI_API_KEY(optionallyOPENAI_BASE_URLfor proxies, Azure, or any OpenAI-compatible server). - Anthropic —
ANTHROPIC_API_KEY. - Google Gemini —
GEMINI_API_KEYorGOOGLE_API_KEY. - OpenAI-compatible endpoint — set
OPENAI_API_KEYto your provider’s key andOPENAI_BASE_URLto its/v1base URL, or uselime login --provider openai-compat --service NAMEto store credentials per service.
- OpenAI —
- Optional:
cloudflaredfor remote control. Lime can auto-download it on first use.
Build from source
git clone https://github.com/NooberCong/lime-codecd lime-codecargo build --releaseThe build produces two binaries:
| Binary | Path | Purpose |
|---|---|---|
lime | target/release/lime | CLI / REPL / bridge / remote control |
srt | target/release/srt | Sandbox runtime (bwrap on Linux, sandbox-exec on macOS) |
Add target/release to your PATH so you can simply type lime:
# bash / zshexport PATH="$PWD/target/release:$PATH"
# Windows PowerShell$env:PATH = "$pwd\target\release;$env:PATH"To embed the current commit hash in lime --version, set GIT_SHA at
build time:
GIT_SHA=$(git rev-parse --short HEAD) cargo build --releaseStore provider credentials
Credentials live under ~/.lime/ and override environment variables when
present. Worker sub-agents inherit the stored key and base URL, so a single
login covers the whole session.
lime login --with-api-key # OpenAI (default)lime login --provider anthropic --with-api-keylime login --provider gemini --with-api-key
# OpenAI-compatible endpoints — each `--service` namespaces credentials,# so multiple compat providers can coexist (Groq, OpenRouter, Together, …).lime login --provider openai-compat --service groq --with-api-key \ --with-base-url https://api.groq.com/openai/v1
lime login --status # Show all providerslime login --status --provider gemini # Show one providerProvider names accepted by --provider: openai, anthropic, gemini,
openai-compat (alias openai_compat).
To remove credentials:
lime logout # Alllime logout --provider gemini # One providerlime logout --provider openai-compat --service groq # One compat serviceVerify the install
lime --versionlime statuslime sandbox # snapshot of sandbox isolationIf lime status reports a healthy session and at least one provider, you’re
ready to go on to the Quickstart.