Skip to content
ankurCES edited this page Jun 7, 2026 · 8 revisions
blumi

A local-first, provider-agnostic agentic coding companion

One Rust core Β· three faces β€” a terminal UI, a web UI, and a phone app.


version 0.3.0 Apache-2.0 local-first bring your own key
Rust Flutter SQLite macOS Linux Android

🌸  rose β†’ lavender β†’ violet β†’ cyan β€” the Living Rose palette that runs through every surface  🩡


Welcome to the blumi wiki β€” everything you need to install, configure, and run blumi across your terminal, browser, phone, and a whole fleet of machines. blumi is a single Rust binary whose UI-agnostic core emits one typed event stream, so every surface shows the same live session.

⭐ Enjoying blumi? Star it on GitHub β€” it genuinely helps others find the project.

πŸš€ Get started in ~60 seconds

# 1. Install (builds the single binary; also sets up the Node + uv helpers)
curl -fsSL https://raw.githubusercontent.com/ankurCES/blumi-cli/main/install.sh | sh

# 2. Pick a provider + paste a key (or point at a local model)
blumi login

# 3. Go β€” the terminal UI
blumi                 # or:  blumi web   (browser UI)   Β·   blumi run "…"  (one-shot)

New here? Installation β†’ Configuration β†’ CLI Usage is the happy path.

🧭 Find your way

Guide What's inside
πŸ“¦ Installation One-line install, prerequisites, building from source
βš™οΈ Configuration The complete settings.json reference β€” every section, field & default
⌨️ CLI Usage Commands, the TUI, slash-commands, the autonomous loop
🌐 Gateway blumi serve + the messaging-bot gateway as always-on services
πŸ“± Mobile App Connect the blugo phone app over your Wi-Fi
πŸ•ΈοΈ Grid (distributed) Β· Demo Run many machines as one fleet that hands off tasks
🧠 Memory & Knowledge Semantic memory (RAG) + a code knowledge base
πŸŽ™οΈ Voice Speak to / hear blumi (STT + TTS)
✨ Self-Management Self-edited config/skills, routing, hooks, notifications, self-healing
πŸ› οΈ Development Architecture + hacking on blumi
🩹 Troubleshooting When something's off
❓ FAQ Why blumi & how it works β€” for decision-makers and developers

πŸ’‘ What blumi can do

  • πŸ–₯️ Three faces, one session β€” a crush-inspired terminal UI, an embedded React web UI, and blugo, a Flutter phone app that mirrors the TUI (and folds gracefully on foldables).
  • πŸ”Œ Bring your own model β€” Anthropic, OpenAI (and any OpenAI-compatible endpoint), Gemini, Azure Foundry, or a fully local server. Switch per-invocation.
  • πŸ’Έ Cost-aware routing β€” auto-route simple turns to a cheap model and hard ones to the flagship; watch the $ saved.
  • 🧠 Memory & code knowledge β€” semantic long-term memory with RAG recall + a local code index, fully offline via a bundled embedder.
  • πŸ•ΈοΈ The grid β€” several machines sharing one secret form a fleet; your phone drives work that runs across all of them.
  • πŸ€– Always-on & autonomous β€” an always-on gateway, an autonomous task loop, proactive discovery, and completion notifications (desktop / bot / phone / browser).
  • ✨ Self-managing β€” it can author its own skills, edit its own (validated) config, reload in place, and self-heal failed steps into learned fixes.

🧩 The three common setups

  1. Local (one machine). Install, blumi login, run blumi (TUI) or blumi web. Nothing else needed. β†’ Installation Β· CLI Usage
  2. Gateway + phone. Run blumi serve as an always-on service; connect blugo over Wi-Fi (it auto-discovers the gateway on your network). β†’ Gateway Β· Mobile App
  3. Grid (many machines). Install on several machines, give them the same grid.secret; they auto-discover and hand off tasks. Any node β€” or your phone β€” drives the fleet. β†’ Grid

πŸ“Ž Conventions used here

  • Config lives in ~/.blumi/settings.json (global) + a per-project .blumi/ overlay.
  • Services are com.blumi.serve / com.blumi.gateway (launchd, macOS) or blumi-serve / blumi-gateway (systemd user, Linux).
  • Secrets β€” API keys, the grid secret, the gateway password hash β€” stay in settings.json (mode 0600), never in git.

Install Β· Configure Β· CLI Β· Gateway Β· Mobile Β· Grid Β· Memory Β· Voice Β· Self-Management Β· FAQ

Made with 🌸 β€” Apache-2.0 Β· github.com/ankurCES/blumi-cli

Clone this wiki locally