Which integrations are available for this server?

Provides semantic indexing and relationship mapping for C++ codebases, extracting class and function information from source files. Integrates with Git for AI-powered automated commits and ensures indexing respects project .gitignore configurations. Enables intelligent code indexing and semantic search for JavaScript projects, supporting ES6 imports/exports and function declarations. Indexes Markdown documentation to enable semantic search across document headers and content sections. Provides indexing and analysis for PHP source code, supporting class and function extraction with namespace support. Delivers deep indexing for Python projects, including extraction of imports, classes, functions, and docstring parsing for semantic understanding. Supports indexing and semantic search for Ruby codebases, identifying class, module, and method definitions. Provides comprehensive indexing of Rust codebases using full AST parsing to map module structures and public declarations. Analyzes TypeScript codebases to extract type definitions and interfaces for intelligent context and semantic search.

Octocode - Intelligent Code Indexer and Graph Builder

License Rust

🚀 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 .gitignore: Never indexes sensitive files or directories
🛡️ MCP security: Server runs locally with no external network access for search
🌐 Cloud embeddings: Voyage AI and other providers process only file metadata, not source code