为AI代理和开发者提供以证据为先的代码研究。

Octocode 用一套工具研究你的本地代码和外部代码（GitHub仓库、PR、npm），包括 ripgrep + AST 搜索、树、精确读取和 LSP。将其用作 CLI 或 MCP 服务器，由 Rust 引擎支持，实现单文件或大型仓库快速高效的令牌效果。

---

目录

• 快速入门
• 为什么选择八字代码
• 为研究（基准测试）而建
• 工具
• MCP
• CLI
• 配置
• 认证方法
• 安全
• 语言支持
• 技能
• 建筑学
• 文档
• 故障排除
• 代理工作流程

---

快速开始

先决条件： Node.js 20.12+

1.运行带有 [[T0] 的 Octocode CLI

2.使用 GitHub 认证——可选，但可解锁私有仓库和更高的 API 速率限制：

3.选择你的界面。 两者使用相同的工具和Rust引擎。（克隆已由 默认CLI，选择加入MCP。）

** 🖥️ CLI** - 直接从你的终端进行研究：

** 🤖 MCP** - 一键安装：

显示更多安装选项（Windsurf、Kiro、Goose、LM Studio、Claude Code）

克劳德代码：

Octocode: agentic research platform

Evidence-first code research for AI agents and developers.

Octocode researches your local code and external code alike (GitHub repositories, PRs, npm) with one toolset: ripgrep + AST search, trees, precise reads, and LSP. Use it as a CLI or MCP server, backed by a Rust engine for fast, token-efficient results across single files or mega-repos.

---

Table of contents

• Quick start
• Why Octocode
• Built for research (benchmarks)
• Tools
• MCP
• CLI
• Configuration
• Authentication methods
• Security
• Language support
• Skills
• Architecture
• Documentation
• Troubleshooting
• Agent workflows

---

Quick start

Prerequisites: Node.js 20.12+

1. Run the Octocode CLI with npx

npx octocode --help

2. Authenticate with GitHub - optional, but unlocks private repositories and higher API rate limits:

npx octocode auth login
npx octocode status       # verify the active token source

3. Choose your interface. Same tools and Rust engine on both. (Clone is on by default in the CLI, opt-in for MCP.)

🖥️ CLI - research straight from your terminal:

npx octocode

🤖 MCP - one-click install: