Documentation

Learn how to use Octomind to build powerful AI agents without writing code.

Dev

Building from Source

## Prerequisites

Architecture

Internal architecture overview for Octomind contributors.

MCP Server Development

Guide for adding new built-in MCP servers to Octomind.

WebSocket Server

Octomind provides a WebSocket server for remote AI sessions, enabling programmatic access from web clients, bots, and automation tools.

ACP Protocol

The Agent Client Protocol (ACP) enables Octomind to run as a sub-agent over stdio, communicating via JSON-RPC. This is used for editor integration and

Daemon Mode and Webhook Hooks

Run Octomind as a persistent background session that reacts to external events.

Tap System

Taps are Homebrew-style registries for distributing Octomind agents, skills, and capabilities.

CLI Reference

Complete reference for all `octomind` CLI commands and flags.

Session Commands Reference

All commands available within an interactive Octomind session. Type the command at the prompt.

Configuration Reference

Complete field-by-field reference for `~/.local/share/octomind/config/config.toml`.

Environment Variables Reference

## API Keys

Common Issues

## Installation

Migration Guide

## Provider Format

Installation

## Prerequisites

Quickstart

Get from zero to a productive AI session in 5 minutes.

Configuration

Octomind uses TOML configuration files stored in a platform-specific data directory.

AI Providers

Octomind supports 7 AI providers through a unified interface. Provider support is implemented in [octolib](https://github.com/muvon/octolib) -- new pr

Sessions

All interaction with Octomind happens through sessions. A session is a conversation with context, tool access, and cost tracking.

Roles and Permissions

Roles control what the AI can do in a session: which tools are available, what system prompt is used, and how the AI behaves.

MCP Tools Reference

Octomind uses the Model Context Protocol (MCP) to provide AI models with external tools. This is the single reference for all built-in tools.

Context Compression

Octomind automatically manages conversation context size through intelligent compression. This is the single reference for the compression system.

Workflows

Workflows are multi-step AI processing pipelines that enhance user requests before the main AI processes them. They implement a planner-executor separ

Commands, Layers, Agents, and Prompts

Octomind provides four mechanisms for extending AI capabilities beyond the base session.

Structured Output

Octomind supports enforcing structured JSON output via the `--schema` flag. Useful for automation, CI/CD pipelines, and machine-readable responses.

Editor Integration

Octomind integrates with code editors via the ACP (Agent Client Protocol), providing AI assistance directly in your IDE.

Use Case: Automated Code Review in CI/CD

Run Octomind as part of your CI/CD pipeline to automatically review pull requests, check for security issues, or enforce coding standards.

Use Case: Event-Driven Agent with Webhooks

Run Octomind as a persistent daemon that reacts to external events -- GitHub pushes, Slack messages, monitoring alerts.

Use Case: Custom Development Workflow

Build a multi-stage AI pipeline that refines, researches, and validates tasks before the main AI executes them.

Use Case: Web Dashboard with AI Assistant

Embed Octomind into a web application as a real-time AI coding assistant using the WebSocket server.

Use Case: Multi-Agent Task Delegation

Split complex tasks across specialized AI agents that work independently and report back to a coordinator.

Use Case: AI Self-Configuring MCP Servers at Runtime

Let the AI discover what tools it needs and connect new MCP servers on the fly -- no config changes, no restarts.

Use Case: Scheduled Tasks and Timed Automation

Use the built-in `schedule` tool to have the AI perform actions at specific times during a session -- reminders, periodic checks, timed workflows.

Use Case: Long-Running Development with Session Resume

Use named sessions and resume to work on complex tasks across multiple sittings without losing context.

Use Case: Custom Hooks -- Build Any Integration in Any Language

Hooks are HTTP listeners backed by scripts you write in any language. You have full control: parse any payload, filter events, transform data, and inj

Octomind Documentation

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

GitHub Repository

View source code, contribute, or report issues

Support

Get help and report issues on GitHub

Dev