https://github.com/chriswritescode-dev/codedox
A powerful system for crawling documentation websites, extracting code snippets, and providing fast search capabilities via MCP (Model Context Protocol) integration.
https://github.com/chriswritescode-dev/codedox
Last synced: 3 months ago
JSON representation
A powerful system for crawling documentation websites, extracting code snippets, and providing fast search capabilities via MCP (Model Context Protocol) integration.
- Host: GitHub
- URL: https://github.com/chriswritescode-dev/codedox
- Owner: chriswritescode-dev
- License: mit
- Created: 2025-07-14T01:03:14.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-12-22T03:37:28.000Z (3 months ago)
- Last Synced: 2025-12-23T07:29:09.801Z (3 months ago)
- Language: Python
- Size: 5.31 MB
- Stars: 25
- Watchers: 0
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
### Markdown Search with Highlighting
### Source Detail View
## 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.