Features

• Multi-provider AI — Works with OpenAI, Anthropic, Google, and more
• Desktop app — Native desktop application for macOS, Windows, and Linux
• Plugin system — Extensible architecture with MCP protocol and custom tools
• Built-in agents — Switch between build (full access) and plan (read-only) modes
• 200k+ token sessions — Handle massive context windows without crashes
• Smart compaction — Automatic memory management for long conversations
• Real-time collaboration — Multi-agent orchestration for complex tasks

Installation

# npm (recommended)
npm i -g octocode-ai

# curl (macOS / Linux)
curl -fsSL https://raw.githubusercontent.com/farhanic017/octocode/main/install | bash

Windows: Install via npm, or download the .exe directly from GitHub Releases.

Uninstall

# npm
npm uninstall -g octocode-ai

# curl install
rm ~/.octocode/bin/octo

Windows: Remove the global npm package, or delete octo.exe from your install directory.

Quick Start

# Run
octo

Agents

| Agent | Access | Use Case | |-------|--------|----------| | build | Full read/write | Default agent for development work | | plan | Read-only | Analysis, exploration, and planning | | compose | Multi-agent | Orchestrates parallel sub-agents for complex tasks | | agent-swarm | Distributed | Spawns autonomous agents for large-scale operations |

Commands

| Command | Description | |---------|-------------| | /understand | Analyze and remember codebases, files, plans, designs, packages | | /dream | Consolidate memories — distill session insights into persistent knowledge | | /distill | Create reusable skills from successful workflows | | /md | Generate session summaries and save to vault |

Documentation

For configuration, plugins, and advanced usage, visit octocode.ai/docs.

Notice: This project was previously hosted at farhanic017/octo-code. It has been renamed to octocode and restructured. Please update your bookmarks and remotes.

Changelog

See CHANGELOG.md for version history.

Community

• Discord — Get help and connect with the community
• X.com — Follow for updates

Contributing

See CONTRIBUTING.md for development setup and guidelines.

License

GNU General Public License v3.0