$git clone https://github.com/bgauryy/octocode</div>
| 1 | # Octocode - Agentic Research Platform |
| 2 | |
| 3 | <div align="center"> |
| 4 | <img src="https://github.com/bgauryy/octocode/raw/main/packages/octocode-mcp/assets/logo_white.png" width="400px" alt="Octocode Logo"> |
| 5 | |
| 6 | [](https://github.com/modelcontextprotocol/servers) |
| 7 | [](https://deepwiki.com/bgauryy/octocode) |
| 8 | |
| 9 | [](https://octocode.ai) |
| 10 | [](https://www.youtube.com/@Octocode-ai) |
| 11 | |
| 12 | </div> |
| 13 | |
| 14 | **Evidence-first code research for AI agents and developers.** |
| 15 | |
| 16 | Evidence from your **local workspace** and **external** sources (GitHub repos, PRs, npm). One toolset: ripgrep + AST search, trees, precise reads, and LSP — as a **CLI** or **MCP server**, backed by a **Rust engine** for fast, token-efficient results across single files or mega-repos. |
| 17 | |
| 18 | --- |
| 19 | |
| 20 | ## Table of Contents |
| 21 | |
| 22 | - [Quick Start](#quick-start) |
| 23 | - [Why Octocode](#why-octocode) |
| 24 | - [What You Can Do](#what-you-can-do) |
| 25 | - [Tools](#tools) |
| 26 | - [MCP](#mcp) |
| 27 | - [CLI](#cli) |
| 28 | - [Configuration](#configuration) |
| 29 | - [Authentication Methods](#authentication-methods) |
| 30 | - [Security](#security) |
| 31 | - [Language Support](#language-support) |
| 32 | - [Skills](#skills) |
| 33 | - [Architecture](#architecture) |
| 34 | - [Documentation](#documentation) |
| 35 | - [Troubleshooting](#troubleshooting) |
| 36 | |
| 37 | --- |
| 38 | |
| 39 | ## Quick Start |
| 40 | |
| 41 | **1. Run the Octocode CLI with `npx`** |
| 42 | |
| 43 | ```bash |
| 44 | npx octocode --help |
| 45 | ``` |
| 46 | |
| 47 | **2. Authenticate with GitHub** — optional, but unlocks private repositories and higher API rate limits: |
| 48 | |
| 49 | ```bash |
| 50 | npx octocode auth login |
| 51 | npx octocode status # verify the active token source |
| 52 | ``` |
| 53 | |
| 54 | **3. Choose your interface.** The same engine and 12 tools run identically either way. |
| 55 | |
| 56 | **🖥️ CLI** — research straight from your terminal: |
| 57 | |
| 58 | ```bash |
| 59 | npx octocode |
| 60 | ``` |
| 61 | |
| 62 | **🤖 MCP** — one-click install: |
| 63 | |
| 64 | - [<img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor">](https://cursor.com/en/install-mcp?name=octocode&config=eyJjb21tYW5kIjoibnB4IiwidHlwZSI6InN0ZGlvIiwiYXJncyI6WyJAb2N0b2NvZGVhaS9tY3BAbGF0ZXN0Il19) |
| 65 | - [<img src="https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white" alt="Install in VS Code">](https://insiders.vscode.dev/redirect/mcp/install?name=octocode&config=%7B%22command%22%3A%22npx%22%2C%22type%22%3A%22stdio%22%2C%22args%22%3A%5B%22%40octocodeai%2Fmcp%40latest%22%5D%7D) |
| 66 | - [<img src="https://img.shields.io/badge/VS_Code_Insiders-Install_Server-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white" alt="Install in VS Code Insiders">](https://insiders.vscode.dev/redirect/mcp/install?name=octocode&config=%7B%22command%22%3A%22npx%22%2C%22type%22%3A%22stdio%22%2C%22args%22%3A%5B%22%40octocodeai%2Fmcp%40latest%22%5D%7D&quality=insiders) |
| 67 | - [<img src="https://img.shields.io/badge/Windsurf-Install_Server-1a1a1a?style=flat-square&logoColor=white" alt="Install in Windsurf">](windsurf://mcp/install?name=octocode&config=%7B%22command%22%3A%22npx%22%2C%22type%22%3A%22stdio%22%2C%22args%22%3A%5B%22%40octocodeai%2Fmcp%40latest%22%5D%7D) |
| 68 | - [<img src="https://kiro.dev/images/add-to-kiro.svg" alt="Install in Kiro">](https://kiro.dev/launch/mcp/add?name=octocode&config=%7B%22command%22%3A%22npx%22%2C%22type%22%3A%22stdio%22%2C%22args%22%3A%5B%22%40octocodeai%2Fmcp%40latest%22%5D%7D) |
| 69 | - [<img src="https://goose-docs.ai/img/extension-install-dark.svg" alt="Install in Goose">](https://goose-docs.ai/extension?cmd=npx&arg=%40octocodeai%2Fmcp%40latest&id=octocode&name=octocode&description=Evidence-first%20code%20research%20for%20AI%20agents) |
| 70 | - [<img src="https://files.lmstudio.ai/deeplink/mcp-install-light.svg" alt="Install in LM Studio">](https://lmstudio.ai/install-mcp?name=octocode&config=eyJjb21tYW5kIjoibnB4IiwidHlwZSI6InN0ZGlvIiwiYX |