KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #typescript #codex #cli #claude-code #mcp #rust #deepseek-harness #ai-agent

codedox

★ 29 Open GitHub ↗

A powerful system for crawling documentation websites, extracting code snippets, and providing fast search capabilities via MCP (Model Context Protocol) integration.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# CodeDox - AI-Powered Documentation Search & Code Extraction

**Transform any documentation site into a searchable code database** - CodeDox crawls documentation websites, intelligently extracts code snippets with context, and provides lightning-fast search via PostgreSQL full-text search and MCP (Model Context Protocol) integration for AI assistants.

## 📚 Documentation

For full documentation, installation guides, API reference, and more, visit:

### **[https://chriswritescode-dev.github.io/codedox/](https://chriswritescode-dev.github.io/codedox/)**

## Quick Start

### Docker Setup (Recommended)

```bash
# Clone the repository
git clone https://github.com/chriswritescode-dev/codedox.git
cd codedox

# Configure environment
cp .env.example .env
# Edit .env to add your CODE_LLM_API_KEY (optional for AI-enhanced extraction)

# Run the automated setup
./docker-setup.sh

# Access the web UI at http://localhost:5173
# MCP tools available at http://localhost:8000/mcp
```

### Manual Installation

See the [full installation guide](https://chriswritescode-dev.github.io/codedox/getting-started/installation/) for detailed instructions.

## Key Features

- **Intelligent Web Crawling**: Depth-controlled crawling with URL pattern filtering and domain restrictions
- **Smart Code Extraction**: Dual-mode extraction (Automatic Title / Description or LLM Generated Titles and Descriptions)
- **Enhanced Search Modes**: Standard code search with intelligent markdown fallback for comprehensive results
- **Lightning-Fast Search**: PostgreSQL full-text search with fuzzy matching
- **GitHub Repository Processing**: Clone and extract documentation from GitHub repositories with full path support (e.g., `/tree/main/docs`)
- **HTTP-First MCP Integration**: MCP tools via HTTP endpoints with Streamable HTTP transport support (MCP 2025-03-26 spec)
- **Full Documentation Access**: Get complete markdown content from any documentation page for full context
- **Modern Web Dashboard**: React + TypeScript UI for visual management
- **Version Support**: Track multiple versions of documentation
- **Real-time Monitoring**: Live crawl progress and health monitoring
- **Upload Support**: Upload documentation directly or from GitHub repositories (useful for repos with doc sites)

## Demo - MCP Integration Example - OpenCode TUI

## Screenshots

### Dashboard
<img src="docs/screenshots/WebUI-Dashboard.webp" alt="CodeDox Dashboard" width="800">

### Markdown Search with Highlighting
<img src="docs/screenshots/CodeDoX-WebUI-Markdown-Search.webp" alt="CodeDox Markdown Search" width="800">

### Source Detail View
<img src="docs/screenshots/WebUI-Source-Detail.webp" alt="CodeDox Source Detail" width="800">

## Documentation

- [Getting Started](https://chriswritescode-dev.github.io/codedox/getting-started/quickstart/)
- [Installation Guide](https://chriswritescode-dev.github.io/codedox/getting-started/installation/)
- [API Reference](https://chriswritescode-dev.github.io/codedox/api/rest/)
- [MCP Integration](https://chriswritescode-dev.github.io/codedox/features/mcp/)
- [Architecture Overview](https://chriswritescode-dev.github.io/codedox/development/architecture/)

## Contributing

See our [Contributing Guide](https://chriswritescode-dev.github.io/codedox/development/contributing/) for details on how to contribute to CodeDox.

## Author

**Chris Scott** - [chriswritescode.dev](https://chriswritescode.dev)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

codedox

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README