-
Notifications
You must be signed in to change notification settings - Fork 0
Installation
blumi is a coding agent that ships as a single, self-contained binary for macOS and Linux. To install blumi, run one curl one-liner (curl -fsSL https://raw.githubusercontent.com/ankurCES/blumi-cli/main/install.sh | sh) or build it from source with cargo, then run blumi login to pick a provider. This page covers every install path: the quick installer, building from source, optional feature flags, GPU/embeddings builds, external tools, and verification.
-
Install one-liner (macOS / Linux):
curl -fsSL https://raw.githubusercontent.com/ankurCES/blumi-cli/main/install.sh | sh -
What it is: blumi is a single binary — no runtime, no Node/JS toolchain needed for a plain build (the React web UI's
dist/is committed and embedded). -
Default install location:
~/.local/bin(override with theBLUMI_INSTALL_DIRenvironment variable); make sure it's on yourPATH. - Prerequisites: none for the prebuilt release; Rust (from https://rustup.rs) only if you build from source.
- Platforms: macOS (Apple Silicon GPU embedder via CoreML is on by default) and Linux (NVIDIA CUDA is opt-in).
-
Verify:
blumi --versionandblumi --help. -
Next step: run
blumi loginto choose a provider and model.
curl -fsSL https://raw.githubusercontent.com/ankurCES/blumi-cli/main/install.sh | shThis installs blumi into ~/.local/bin (override with BLUMI_INSTALL_DIR). It downloads a
prebuilt release for your platform when available, otherwise builds from source with cargo.
Make sure ~/.local/bin is on your PATH:
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc # or ~/.bashrc
Building from source requires the Rust toolchain and nothing else. Install Rust from https://rustup.rs, then:
# install the published crate cargo install --git https://github.com/ankurCES/blumi-cli --locked blumi # or clone + build git clone https://github.com/ankurCES/blumi-cli && cd blumi-cli cargo install --path crates/blumi --locked
A plain cargo build needs no JS/Node toolchain — the React web UI's built dist/ is
committed and embedded.
Some backends are feature-gated to keep the default build lean, so you opt into them at install time. Pass them via --features:
cargo install --path crates/blumi --locked --features docker,ssh,lsp
-
docker— run tools inside a container (--sandbox docker) -
ssh— run tools on a remote host over SSH -
lsp— the code-intel LSP tool
The bundled ONNX embedder (used by memory and code search) is enabled by default on Apple Silicon and opt-in everywhere else. ONNX is the open neural-network runtime blumi uses to generate embeddings locally:
- macOS (Apple Silicon) — the GPU embedder (CoreML) is on by default; nothing to add.
-
NVIDIA / Linux — opt in via the installer:
...or from source:
curl -fsSL https://raw.githubusercontent.com/ankurCES/blumi-cli/main/install.sh | BLUMI_CUDA=1 shcargo install --path crates/blumi --locked --features gpu-cuda. The installer auto-detects an NVIDIA GPU, ships the ONNX Runtime.sonext to the binary, verifies it loads, and falls back to a lean build if anything's off. -
local-embeddings— the CPU ONNX embedder on a non-Apple host (without it, memory + code search use FTS5 keyword search). Most NVIDIA users are better off keeping blumi lean and running Ollama for GPU LLM + embeddings — see Memory & Knowledge → GPU acceleration.
blumi shells out to a few common command-line tools when they are present, and all of them are optional:
-
git/gh— version control + GitHub operations the agent performs. - Node + uv — used by default MCP servers; the installer offers to set these up. See CLI Usage → mcp.
Confirm blumi is installed and on your PATH by printing its version and help:
blumi --version blumi --help
You only need Flutter if you intend to build blugo, the companion phone app. To build blugo you need Flutter; see Mobile App. You do not need Flutter to use the blumi CLI or the gateway.
No — installing blumi requires no API key. You provide a provider key (or point at a local,
keyless server) afterward by running blumi login. See
Configuration for providers, keys, and models.
You need Rust only if you build from source (install it from https://rustup.rs). The prebuilt
release downloaded by the installer needs no toolchain at all. You never need a JS/Node toolchain
for a plain build — the React web UI's built dist/ is committed and embedded in the binary.
(Node and uv are used only by the default MCP — Model Context Protocol — servers, and the installer
offers to set them up.)
Set the BLUMI_INSTALL_DIR environment variable before running the installer. By default the
installer puts the blumi binary in ~/.local/bin; make sure that directory is on your PATH.
Run the installer with BLUMI_CUDA=1 (curl -fsSL .../install.sh | BLUMI_CUDA=1 sh), or build from
source with --features gpu-cuda. On macOS (Apple Silicon) the CoreML GPU embedder is on by
default with nothing to add. Most NVIDIA users are better off keeping blumi lean and running
Ollama for GPU LLM and embeddings.
Re-run the same install command you used originally — the installer fetches the latest prebuilt
release (or rebuilds from source). If you installed with cargo install --git, re-running it pulls
and reinstalls the newest version.
- Configuration — providers, keys, models.
- CLI Usage — the commands.
- Gateway — run it always-on for the phone app.