![\"Discord\"](\"https://img.shields.io/badge/discord-0%20online-7289da?style=flat-square\"){kind=icon}
\n ![\"npm\"](\"https://img.shields.io/npm/v/octocode-ai?style=flat-square\")
\n ![\"License:](\"https://img.shields.io/badge/license-GPL--3.0-blue.svg?style=flat-square\"){kind=icon}
\n ![\"Downloads\"](\"https://img.shields.io/npm/dm/octocode-ai?style=flat-square&label=downloads\")
\n ![\"Sponsor\"](\"https://img.shields.io/badge/sponsor-%E2%9D%A4-pink?style=flat-square\"){kind=icon}
\nThe open source AI coding agent.
\n\n \n
Created by Farhan Dhrubo
\n\n[](https://github.com/farhanic017/octocode)\n\n---\n\n## Features\n\n- **Multi-provider AI** — Works with OpenAI, Anthropic, Google, and more\n- **Desktop app** — Native desktop application for macOS, Windows, and Linux\n- **Plugin system** — Extensible architecture with MCP protocol and custom tools\n- **Built-in agents** — Switch between `build` (full access) and `plan` (read-only) modes\n- **200k+ token sessions** — Handle massive context windows without crashes\n- **Smart compaction** — Automatic memory management for long conversations\n- **Real-time collaboration** — Multi-agent orchestration for complex tasks\n\n## Installation\n\n```bash\n# npm (recommended)\nnpm i -g octocode-ai\n\n# curl (macOS / Linux)\ncurl -fsSL https://raw.githubusercontent.com/farhanic017/octocode/main/install | bash\n```\n\n**Windows:** Install via npm, or download the `.exe` directly from [GitHub Releases](https://github.com/farhanic017/octocode/releases).\n\n### Uninstall\n\n```bash\n# npm\nnpm uninstall -g octocode-ai\n\n# curl install\nrm ~/.octocode/bin/octo\n```\n\n**Windows:** Remove the global npm package, or delete `octo.exe` from your install directory.\n\n### Quick Start\n\n```bash\n# Run\nocto\n```\n\n## Agents\n\n| Agent | Access | Use Case |\n|-------|--------|----------|\n| `build` | Full read/write | Default agent for development work |\n| `plan` | Read-only | Analysis, exploration, and planning |\n| `compose` | Multi-agent | Orchestrates parallel sub-agents for complex tasks |\n| `agent-swarm` | Distributed | Spawns autonomous agents for large-scale operations |\n\n## Commands\n\n| Command | Description |\n|---------|-------------|\n| `/understand` | Analyze and remember codebases, files, plans, designs, packages |\n| `/dream` | Consolidate memories — distill session insights into persistent knowledge |\n| `/distill` | Create reusable skills from successful workflows |\n| `/md` | Generate session summaries and save to vault |\n\n\n## Documentation\n\nFor configuration, plugins, and advanced usage, visit **[octocode.ai/docs](https://octocode.ai/docs)**.\n\n> **Notice:** This project was previously hosted at `farhanic017/octo-code`. It has been renamed to `octocode` and restructured. Please update your bookmarks and remotes.\n\n## Changelog\n\nSee [CHANGELOG.md](./CHANGELOG.md) for version history.\n\n## Community\n\n- [Discord](https://discord.gg/octocode) — Get help and connect with the community\n- [X.com](https://x.com/farhanic0) — Follow for updates\n\n## Contributing\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup and guidelines.\n\n## License\n\n[GNU General Public License v3.0](./LICENSE)\n","readmeFilename":"README.md"}