octocode
| Crates.io | octocode |
| lib.rs | octocode |
| version | 0.10.0 |
| created_at | 2025-06-26 04:14:20.565522+00 |
| updated_at | 2025-09-14 08:40:17.326631+00 |
| description | AI-powered code indexer with semantic search, GraphRAG knowledge graphs, and MCP server for multi-language codebases |
| homepage | https://octocode.muvon.io |
| repository | https://github.com/muvon/octocode |
| max_upload_size | |
| id | 1726842 |
| size | 1,699,959 |
Don Hardman (donhardman)
documentation
https://docs.rs/octocode
README
Octocode - Intelligent Code Indexer and Graph Builder
© 2025 Muvon Un Limited (Hong Kong) | Website | Product Page
🚀 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
🤝 Support & Community
- 🐛 Issues: GitHub Issues
- 📧 Email: opensource@muvon.io
- 🏢 Company: Muvon Un Limited (Hong Kong)
⚖️ License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
Built with ❤️ by the Muvon team in Hong Kong