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/
Quick Start
Docker Setup (Recommended)
# 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 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
Contributing
See our Contributing Guide for details on how to contribute to CodeDox.
Author
Chris Scott - chriswritescode.dev
License
This project is licensed under the MIT License - see the LICENSE file for details.
Metadata
Release files for iflow-mcp_chriswritescode-dev_codedox 0.3.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| iflow_mcp_chriswritescode_dev_codedox-0.3.9.tar.gz | 132.7 kB | Without provenance | Details for iflow_mcp_chriswritescode_dev_codedox-0.3.9.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| iflow_mcp_chriswritescode_dev_codedox-0.3.9-py3-none-any.whl | Python 3 | none | any | Details for iflow_mcp_chriswritescode_dev_codedox-0.3.9-py3-none-any.whl |
Total release size: 303.2 kB
Release files / iflow_mcp_chriswritescode_dev_codedox-0.3.9.tar.gz
| Download URL | iflow_mcp_chriswritescode_dev_codedox-0.3.9.tar.gz |
|---|---|
| Size | 132.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
959893e31b57b74ab5f3dc3a5cb586cdb85199d9f69906487637aa82abe437e7
|
|
BLAKE2b-256 checksum How to use checksums |
f2c62e814bec9bf86712ee45f21b1e4b86419d9917e2ccba2e7425af53250307
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / iflow_mcp_chriswritescode_dev_codedox-0.3.9-py3-none-any.whl
| Download URL | iflow_mcp_chriswritescode_dev_codedox-0.3.9-py3-none-any.whl |
|---|---|
| Size | 170.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d17f801d36c552502e9079bfcdfae50c5bbf407eda5d00a56dd0d0d907620b88
|
|
BLAKE2b-256 checksum How to use checksums |
de3f9f69fade13156a53a2208b5f396ec06f8b4f0a896d0b4e791a1f869e981a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for iflow-mcp_chriswritescode-dev_codedox 0.3.9
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.