What are the requirements for Octocode?

Octocode requires the following environment variables: VOYAGE_API_KEY (required), OPENROUTER_API_KEY (optional). You'll also need a compatible MCP client like Claude Desktop or Claude Code.

Is Octocode free to use?

Yes, Octocode is open source and free to use. You can find the source code on GitHub.

What MCP clients support Octocode?

Octocode works with any MCP-compatible client including Claude Desktop (Anthropic's official desktop app), Claude Code (CLI tool), Cursor, and other editors with MCP support.

How do I configure Octocode?

Configure Octocode by adding it to your MCP client's config file. For Claude Desktop, edit claude_desktop_config.json and add the server configuration. See the Configuration section above for a ready-to-use example.

Octocode MCP Server

Q: What tools does Octocode provide?

search: Perform natural language semantic search across the indexed codebase. index: Index the codebase to build the knowledge graph.

Q: How do I install Octocode?

Install Octocode by running: curl -fsSL https://raw.githubusercontent.com/Muvon/octocode/master/install.sh | sh

Local setup required. This server has to be cloned and prepared on your machine before you register it in Claude Code.

Set the server up locally

Run this once to clone and prepare the server before adding it to Claude Code.

Run in terminal

git clone https://github.com/Muvon/octocode
cd octocode

Then follow the repository README for any remaining dependency or build steps before continuing.

Register it in Claude Code

After the local setup is done, run this command to point Claude Code at the built server.

Run in terminal

claude mcp add -e "VOYAGE_API_KEY=${VOYAGE_API_KEY}" octocode -- node "<FULL_PATH_TO_OCTOCODE>/dist/index.js"

Replace <FULL_PATH_TO_OCTOCODE>/dist/index.js with the actual folder you prepared in step 1.

Required:VOYAGE_API_KEY+ 1 optional

README.md

Intelligent code indexer and semantic search engine with GraphRAG

Octocode - Intelligent Code Indexer and Graph Builder

🚀 Overview

Octocode is a powerful code indexer and semantic search engine that builds intelligent knowledge graphs of your codebase. It combines advanced AI capabilities with local-first design to provide deep code understanding, relationship mapping, and intelligent assistance for developers.

✨ Key Features

🔍 Semantic Code Search - Natural language queries with multi-query support
🕸️ Knowledge Graph (GraphRAG) - Automatic relationship discovery between files
🌐 Multi-Language Support - Rust, Python, JavaScript, TypeScript, Go, PHP, C++, Ruby, and more
🧠 AI-Powered Features - Smart commits, code review, memory system with semantic search
🔌 MCP Server Integration - Built-in Model Context Protocol server with LSP support
⚡ Performance & Flexibility - Intelligent LanceDB optimization, local/cloud embedding models

📦 Quick Installation

# Universal install script (Linux, macOS, Windows)
curl -fsSL https://raw.githubusercontent.com/Muvon/octocode/master/install.sh | sh

Alternative methods:

Download from GitHub Releases
Install with Cargo: cargo install --git https://github.com/Muvon/octocode

For detailed installation instructions, see Installation Guide.

🔑 API Keys Setup

⚠️ Required for functionality:

# Required: Voyage AI (embeddings) - 200M free tokens/month
export VOYAGE_API_KEY="your-voyage-api-key"

# Optional: OpenRouter (LLM features)
export OPENROUTER_API_KEY="your-openrouter-api-key"

Get your free API keys:

Voyage AI: Get free API key (200M tokens/month free)
OpenRouter: Get API key (optional, for AI features)

🚀 Quick Start

# 1. Index your codebase
octocode index

# 2. Search with natural language
octocode search "HTTP request handling"

# 3. Multi-query search for comprehensive results
octocode search "authentication" "middleware"

# 4. AI-powered git workflow
octocode commit --all

# 5. Start MCP server for AI assistants
octocode mcp --path /path/to/your/project

📚 Complete Documentation

📖 Quick Navigation

Installation Guide - Detailed installation methods and building from source
Getting Started - First steps and basic workflow
API Keys Setup - Complete API configuration guide
Configuration Guide - Configuration system, templates, and customization
Commands Reference - Complete command reference with examples
Advanced Usage - Advanced features and workflows
MCP Integration - Model Context Protocol server setup
LSP Integration - Language Server Protocol integration
Memory System - Memory management and semantic search
Release Management - AI-powered release automation
Architecture - Core components and system design
Performance - Performance metrics and optimization
Contributing - Development setup and contribution guidelines

🌐 Supported Languages

Language	Extensions	Features
Rust	`.rs`	Full AST parsing, pub/use detection, module structure
Python	`.py`	Import/class/function extraction, docstring parsing
JavaScript	`.js`, `.jsx`	ES6 imports/exports, function declarations
TypeScript	`.ts`, `.tsx`	Type definitions, interface extraction
Go	`.go`	Package/import analysis, struct/interface parsing
PHP	`.php`	Class/function extraction, namespace support
C++	`.cpp`, `.hpp`, `.h`	Include analysis, class/function extraction
Ruby	`.rb`	Class/module extraction, method definitions
JSON	`.json`	Structure analysis, key extraction
Bash	`.sh`, `.bash`	Function and variable extraction
Markdown	`.md`	Document section indexing, header extraction

🔒 Privacy & Security

🏠 Local-first option: FastEmbed and SentenceTransformer run entirely offline (macOS only)
🔑 Secure storage: API keys stored locally, environment variables supported
**📁 Respects .gi

Tools (2)

searchPerform natural language semantic search across the indexed codebase

indexIndex the codebase to build the knowledge graph

Environment Variables

VOYAGE_API_KEYrequiredAPI key for Voyage AI embeddings

OPENROUTER_API_KEYOptional API key for OpenRouter LLM features

Configuration

claude_desktop_config.json

{"mcpServers": {"octocode": {"command": "octocode", "args": ["mcp", "--path", "/path/to/your/project"]}}}

Try it

→Search for the implementation of HTTP request handling in this codebase.

→Find all files related to authentication and middleware logic.

→Explain the architecture of the current project based on the knowledge graph.

→Identify which modules are responsible for database interactions.

Frequently Asked Questions

What are the key features of Octocode?

Semantic code search with natural language support. GraphRAG knowledge graph for relationship discovery. Multi-language support including Rust, Python, JS, TS, Go, and more. AI-powered features for smart commits and code reviews. Local-first design with intelligent LanceDB optimization.

What can I use Octocode for?

Navigating complex codebases by querying architectural concepts rather than file names. Automating code reviews by leveraging semantic understanding of code relationships. Generating intelligent commit messages based on codebase changes. Onboarding new developers by providing an AI-driven map of project dependencies.

How do I install Octocode?

Install Octocode by running: curl -fsSL https://raw.githubusercontent.com/Muvon/octocode/master/install.sh | sh

What MCP clients work with Octocode?

Octocode works with any MCP-compatible client including Claude Desktop, Claude Code, Cursor, and other editors with MCP support.

Turn this server into reusable context

Keep Octocode docs, env vars, and workflow notes in Conare so your agent carries them across sessions.

Need the old visual installer? Open Conare IDE.

Open Conare

View all ai-tools servers →