octomind README

The project's README from github.com/Muvon/octomind. As one markdown file: README.md.

Octomind — open-source coding agent harness

Open-source coding agent harness. One Rust binary, any model, every surface.

Interactive, stdin, daemon, WebSocket, or ACP — one engine, one config.
A supervising model plans and checks the work.
Policy lives in TOML guardrails, not approval prompts.

CI Crates.io Coverage License Stars

Website · Docs · Tap Registry · Benchmarks · Issues

Octomind mascot: a pixel-art purple octopus with cyan eyes and waving tentacles


Octomind is an open-source coding agent harness. It gives an LLM real access to your repo — reading and writing files, running shells, searching code, delegating to sub-agents — through MCP tools. The same harness runs interactively, non-interactively through stdin, as a background daemon, over WebSocket, or as an ACP agent inside your editor or another agent's stack.

# Interactive
octomind run developer:general

# Piped — CI, scripts, automation
echo "Explain the auth module" | octomind run developer:general --format plain

# Daemon — keep it alive, talk to it from another terminal
echo "watch the build" | octomind run --name watcher --daemon --format jsonl
octomind send --name watcher "run the test suite"

Why Octomind?

Most coding agents assume a human is watching the screen. Octomind is built for the work that keeps going after you leave.

Quick Start

1. Install (macOS, Linux):

curl -fsSL https://raw.githubusercontent.com/muvon/octomind/master/install.sh | bash

On Windows, in PowerShell:

irm https://raw.githubusercontent.com/muvon/octomind/master/install.ps1 | iex

On macOS, you can also install with Homebrew:

brew install muvon/tap/octomind

2. Get model access. The fastest path is Octomind Cloud, which includes models and needs no configuration:

octomind login

Prefer your own provider key? Skip login and export one (also OPENAI_API_KEY, ANTHROPIC_API_KEY, DEEPSEEK_API_KEY), then follow Model access to point the config at it:

export OPENROUTER_API_KEY="your_key"

3. Run a specialist in your project:

cd ~/your/project
octomind run developer:general

You're now in a session with an agent that can read your code, run commands, and edit files. The interface is a plain line prompt with markdown rendering — no TUI to learn, so it works over SSH, in tmux, and in CI logs. The first time you run a specialist, it may install its tools and ask for credentials.

developer:general comes from the default tap muvon/tap, not your local config. Plain octomind run starts the config's default role, assistant:concierge.

Try the recorded bug-fix demo: two failing tests, an agent fix, and an independent test rerun.

Benchmarks

Measured on octobench against 25 tasks harvested from merged pull requests across Python, PHP, Rust, C++, and JavaScript. Each agent works in the pre-fix repo; held-out tests from the merged fix decide pass or fail. These are the published July 30, 2026 results, not a measurement of this checkout.

solved judge Σ / 2500 cost wall time
octomind + glm-5.2 24/25 2264 $63.43 3.6h
claude code + claude-opus-5 23/25 2262 $81.79 6.7h
codex + gpt-5.6-sol 21/25 2127 $14.86 1.0h
opencode + glm-5.2 19/25 2093 $129.54 3.3h

Guardrails: Policy as Code

Drop a .agents/guardrails.toml in your repo. Octomind enforces it deterministically, with no code to compile and no plugin to install.

# Pre-call deny — block a class of calls before they execute
[[guard]]
match   = "shell(command=^rm\\s+-rf?)"
message = "rm -rf blocked."

# Conditional rule — only fires after the agent ran git status this session
[[guard]]
match   = "shell(command=git push)"
when    = ["+shell(command=git status)"]
message = "Review changes before pushing."
Layer When it runs What it does
Guards Before a tool call Deny by capability, argument regex, and session history. A match returns a denial instead of executing the call.
Hooks After a tool result A non-zero exit injects stdout into the agent's inbox — lint and format failures become automatic corrections without restarting the turn.
Validators After a turn Scripts the agent reads on its next turn. This replaces "approve this change?" prompts in autonomous loops.

If you know Claude Code hooks: guards are PreToolUse denies declared in TOML, hooks are PostToolUse, validators are Stop — no scripts required for the common cases.

Hook and validator script examples: Guardrails guide.

One Harness, Five Surfaces

The same harness, exposed wherever your workflow needs it.

Surface Use it for Docs
Interactive CLI Daily work, any domain Sessions
Non-interactive (--format plain / jsonl) CI, scripts, scheduled jobs CLI reference
Daemon + send Background agents, continuous monitoring Daemon & hooks
WebSocket (octomind server) IDE plugins, dashboards, integrations WebSocket server
ACP (octomind acp) Agent inside Zed, JetBrains, VS Code, Neovim, or any ACP editor ACP protocol

Need machine-readable results? Pass --schema schema.json to constrain the final response to a JSON Schema (requires a model with structured-output support). See Structured output.

Features

Feature What you get Learn more
Specialists & taps Packaged agents with model, prompt, MCP servers, and permissions; installs their tool dependencies on first use Tap system
Roles Per-role model, temperature, system prompt, tools Roles
Workflows Multi-step pipelines, each step with its own model and toolset Workflows
MCP client stdio and Streamable HTTP servers, with OAuth; enable/disable servers mid-session MCP tools
Agent Skills Standard SKILL.md skills from .agents/skills/, ~/.config/agents/skills/, and taps; they activate on demand, so your context stays small Skills
Local project tools Executable scripts in .agents/tools/ auto-register as tools Local tools
Plugins & AGENTS.md Agent Plugins (plugin.json + skills + mcp.json) from taps, .agents/plugins/, or ~/.config/agents/plugins/; project AGENTS.md loads at session start Configuration
Supervisor & learning A second model plans, gates completion, and condenses tool output; lessons persist as files per project and role Supervisor, Learning
Sandbox --sandbox locks writes to the working directory via Landlock (Linux) or Seatbelt (macOS), inherited by every shell, MCP server, and sub-agent Config reference
Token efficiency Cache-aware cost accounting and adaptive compression Token efficiency

Specialists

octomind run developer:general    # general dev, language skills auto-activate
octomind run doctor:blood         # blood-test interpretation specialist
octomind run lawyer:sg            # legal specialist

Running a specialist fetches its manifest from the tap registry, installs any required binaries, resolves credentials, starts the right MCP servers, and then opens the session.

Build and register your own:

octomind tap init yourteam/my-tap   # scaffold, validate, git-init, and register locally
octomind tap yourteam/my-tap        # on another machine, after publishing to GitHub

The octomind- prefix is added automatically: yourteam/my-tap maps to the repository yourteam/octomind-my-tap.

Installation

Method Command
Install script (recommended) curl -fsSL https://raw.githubusercontent.com/muvon/octomind/master/install.sh | bash
Install script (Windows PowerShell) irm https://raw.githubusercontent.com/muvon/octomind/master/install.ps1 | iex
Homebrew (macOS) brew install muvon/tap/octomind
Scoop (Windows) scoop bucket add muvon https://github.com/Muvon/scoop-bucket then scoop install muvon/octomind
Cargo (Rust 1.95+) cargo install octomind
Docker docker run --rm ghcr.io/muvon/octomind --help
From source git clone https://github.com/muvon/octomind.git && cd octomind && cargo build --release

The install script detects your OS and architecture (Linux and macOS on x86_64/aarch64) and installs to ~/.local/bin/. Pass --install-dir <DIR> or set OCTOMIND_INSTALL_DIR to override. On Windows (x86_64/aarch64), install.ps1 installs to %LOCALAPPDATA%\octomind\bin and adds it to your user PATH; it honors OCTOMIND_INSTALL_DIR and OCTOMIND_VERSION too. install.sh still works from Git Bash or MSYS2.

Command not found? Add the install directory to your PATH:

export PATH="$HOME/.local/bin:$PATH"

Building from source requires protoc; see Building from source for per-OS prerequisites.

Verify:

octomind --version
octomind config      # generate the default config
octomind run         # start your first session

Shell completions: octomind completion <bash|zsh|fish|elvish|powershell>.

Model access

Octomind Cloud — octomind login (device-code sign-in, like gh auth login) stores a gateway key locally. The default config already uses octohub:auto. Learn more.

Bring your own key — set the provider's environment variable (OPENROUTER_API_KEY, OPENAI_API_KEY, ANTHROPIC_API_KEY, DEEPSEEK_API_KEY, …) and point the model tables at it. The supervisor and compression profiles also default to octohub:auto, so update all three:

[model]
name = "anthropic:claude-sonnet-5-5"

[supervisor.model]
name = "anthropic:claude-haiku-5-5"

[compression.model]
name = "anthropic:claude-haiku-5-5"

Provider details and per-role overrides: Providers & models.

Configuration

Config lives at ~/.local/share/octomind/config/config.toml on macOS and Linux, and under %LOCALAPPDATA%/octomind/config/ on Windows. Set OCTOMIND_DATA_DIR to override the data root.

octomind config --show       # view current config
octomind config --validate   # validate config

Override any value for a single run with -c:

octomind run -c supervisor.enabled=false

Full reference: Configuration reference · Environment variables.

Session commands

Command Description
/help Show all commands
/info Token usage and costs
/model anthropic:claude-sonnet-5-5 Switch model mid-session
/role developer:general Switch to a configured role or tap tag
/new Review auth Start a fresh session (title optional)
/done Force context compression and start background learning extraction when enabled
/exit Exit the session

Full list: Session commands.

Telemetry

Octomind reports anonymous usage: which commands, tools, and models are used, plus timings, token counts, and error kinds. It never sends your code, prompts, file paths, tool arguments, or environment values. Opt out in any of three ways:

export DO_NOT_TRACK=1          # the cross-tool standard, honored first
export OCTOMIND_TELEMETRY=0    # for subsequent commands in this shell
# or set `telemetry = false` in config.toml

Exact field list: Telemetry.

Documentation

Start here Go deeper Integrate Reference
Installation Roles WebSocket server CLI
Quickstart Workflows ACP protocol Config
Configuration Compression Daemon & hooks Session commands
Providers & models Guardrails Editor integration Environment variables

Full index: doc/README.md · Hosted: octomind.run/docs.

Contributing

The most impactful contribution isn't code — it's specialist agents. A cardiologist publishing doctor:medications. A tax attorney publishing lawyer:us. A security researcher publishing security:owasp. One TOML file, and everyone facing that problem gets a specialist-grade AI.

Code contributions are welcome too. Set up the hooks and run the gate before you push:

pip install pre-commit && pre-commit install
make dev    # fmt + clippy + test

Commits follow Conventional Commits. Full guide, architecture overview, and code conventions: CONTRIBUTING.md · internals: Architecture.

Community participation follows our Code of Conduct. Report vulnerabilities privately using the security policy.

License

Apache License 2.0 — see LICENSE.


Octomind by Muvon · Website · Documentation

octomind (Muvon/octomind)

Searching Database…

What is this?Octomind is an open-source coding agent harness. It gives an LLM real access to your repo through MCP tools: reading and writing files, running shells, searching code, and delegating to sub-agents.
Is it an IDE plugin, or something I run in a terminal?It is a single Rust binary. You can run it as an interactive terminal session, non-interactively through stdin in CI or scripts, as a background daemon, over WebSocket, or as an ACP agent inside editors such as Zed, JetBrains, VS Code or Neovim.
How do I get it running?Install it with Homebrew on macOS, cargo install octomind, or the install script (PowerShell on Windows). Then run 'octomind login' for the built-in cloud models or export your own provider key, and start a specialist in your project with 'octomind run developer:general'.
Do I have to sign up somewhere before it can talk to a model?Not if you bring your own provider key. The built-in option is Octomind Cloud: 'octomind login' does a device-code sign-in and stores a gateway key locally, and the default config already uses it.
Does it ask me to approve every edit?No. Policy lives in TOML guardrails: guards deny tool calls before they run, hooks feed lint failures back to the agent, and validators replace approval prompts in autonomous loops. Over budget, a terminal session asks y/N, while a non-interactive run stops with exit code 75.
Can I run it fully offline with a local model?The README does not describe a full offline setup. Ollama is listed as a supported provider, which typically means local models, but the offline workflow itself is not documented in the README.
Does it send my code to the author's servers?The README says the built-in telemetry is anonymous usage data (commands, tools, models, timings, token counts, error kinds) and never includes code, prompts, file paths, tool arguments or environment values. You can opt out. Your prompts still go to whichever model provider you configure.
Does a second model check the agent's work?Yes. A supervisor model plans the work, decides when a task counts as complete, and condenses long tool output so the main agent keeps its context small.
Why did the author build this instead of using an existing agent?The README says most coding agents assume someone is watching the screen. Octomind is built for work that continues after you leave, such as CI runs, daemons and scheduled jobs, with deterministic policy instead of approval popups.
Can it run unattended in the background or on a schedule?Yes. Non-interactive runs with --format plain or jsonl suit CI and cron-style jobs, and the daemon with send handles continuous monitoring. Passing --schema constrains the final answer to a JSON Schema.
What are similar projects?Baize, maki, SystemOneHarness, aichat, dscode, Axl, qwen-code, ruflo
Creator
Muvon
Size
17.8 MB
Stars
403
Age
1y
Commits · 90 Days