Octomind Documentation

**Octomind** is a session-first AI development assistant with built-in MCP tools and multi-provider support.

Getting Started

For users working with Octomind day-to-day.

Document	Description
Installation	Install methods, API keys, shell completions
Quickstart	Zero to productive session in 5 minutes
Configuration	Config files, settings, hierarchy
Providers	AI providers, models, caching, costs
Sessions	Interactive sessions, commands, multimodal
Roles	Roles, permissions, tool access
MCP Tools	All built-in tools reference
Compression	Automatic context compression
Workflows	Multi-step processing pipelines
Commands & Layers	Custom commands, layers, agents, prompts
Structured Output	JSON Schema output for automation
Editor Integration	Neovim, Zed, JetBrains setup

For building on top of Octomind.

Document	Description
WebSocket Server	Remote AI sessions via WebSocket
ACP Protocol	Agent Client Protocol for tool integration
Daemon & Hooks	Background sessions, webhook listeners
Tap System	Registry for agents, skills, capabilities

For contributors to Octomind itself.

Document	Description
Building from Source	Rust setup, build, pre-commit hooks
Architecture	Source modules, internals, patterns
MCP Server Development	Building new MCP servers

Real-world examples showing how to solve practical problems with Octomind.

Document	Description
CI/CD Code Review	Automated code review in pipelines with structured output
Event-Driven Agent	Daemon + webhooks for GitHub, Slack, monitoring
Custom Workflow	Multi-stage refine-research-validate pipeline
Web Dashboard	Embed AI assistant via WebSocket server
Multi-Agent Delegation	Parallel specialized agents for complex tasks
Dynamic MCP Servers	AI self-configuring tools at runtime
Scheduled Tasks	Timed automation, reminders, periodic checks
Long-Running Development	Multi-day tasks with session resume
Custom Hooks	Write hooks in any language for any integration

Document	Description
Common Issues	Installation, config, MCP, session problems
Migration Guide	Upgrading from legacy config formats

Document	Description
CLI Reference	All CLI commands and flags
Session Commands	All 24 interactive session commands
Config Reference	Every configuration field documented
Environment Variables	API keys, overrides, template variables

Octomind -- Session-first AI development assistant