Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Installation

ankurCES edited this page Jun 8, 2026 · 3 revisions

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.

TL;DR / Key facts

  • 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 the BLUMI_INSTALL_DIR environment variable); make sure it's on your PATH.
  • 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 --version and blumi --help.
  • Next step: run blumi login to choose a provider and model.

How do I install blumi? (Quick install, macOS / Linux)

curl -fsSL https://raw.githubusercontent.com/ankurCES/blumi-cli/main/install.sh | sh

This 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

How do I build blumi from source? (needs Rust)

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.

What optional features can I enable?

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

How do I enable GPU / embeddings builds?

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:
    curl -fsSL https://raw.githubusercontent.com/ankurCES/blumi-cli/main/install.sh | BLUMI_CUDA=1 sh
    ...or from source: cargo install --path crates/blumi --locked --features gpu-cuda. The installer auto-detects an NVIDIA GPU, ships the ONNX Runtime .so next 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.

What external tools does blumi use?

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.

How do I verify the install?

Confirm blumi is installed and on your PATH by printing its version and help:

blumi --version
blumi --help

Do I need Flutter? (Mobile app toolchain, only if you'll build blugo)

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.

FAQ

Do I need an API key to install blumi?

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.

Do I need Rust or Node.js to install blumi?

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.)

How do I change where blumi is installed?

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.

How do I enable GPU acceleration on NVIDIA / Linux?

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.

How do I upgrade blumi?

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.

Next

Clone this wiki locally

AltStyle によって変換されたページ (->オリジナル) /