项目介绍
CodeDox - 基于AI的文档搜索与代码提取
将任何文档站点转换为可搜索的代码数据库 - CodeDox 爬取文档网站，智能地提取带上下文的代码片段，并通过 PostgreSQL 全文搜索和 MCP（模型上下文协议）集成提供闪电般的搜索速度。
📚 文档
访问以下链接获取完整的文档、安装指南、API 参考等：
https://chriswritescode-dev.github.io/codedox/
快速开始
Docker 安装（推荐）
# 克隆仓库
git clone https://github.com/chriswritescode-dev/codedox.git
cd codedox
# 配置环境
cp .env.example .env
# 编辑 .env 文件以添加你的 CODE_LLM_API_KEY（可选，用于增强的AI提取）
# 运行自动化设置
./docker-setup.sh
# 访问 Web UI：http://localhost:5173
# MCP 工具：http://localhost:8000/mcp
手动安装
查看详细的安装指南：完整安装指南。
主要功能
- 智能网络爬虫：深度控制爬虫，带有URL模式过滤和域名限制
- 智能代码提取：双模式提取（自动标题/描述或LLM生成的标题和描述）
- 增强搜索模式：标准代码搜索，智能Markdown回退以获得全面的结果
- 闪电般快速搜索：PostgreSQL全文搜索，支持模糊匹配
- GitHub 仓库处理：克隆并从GitHub仓库中提取文档，支持完整路径（例如，
/tree/main/docs） - HTTP优先的MCP集成：通过HTTP端点的MCP工具，支持流式HTTP传输（MCP 2025-03-26规范）
- 完整文档访问：从任何文档页面获取完整的Markdown内容以获得完整上下文
- 现代Web仪表板：React + TypeScript界面用于可视化管理
- 版本支持：跟踪多个版本的文档
- 实时监控：实时爬虫进度和健康状况监控
- 上传支持：直接上传文档或从GitHub仓库上传（对于具有文档站点的仓库非常有用）
演示 - MCP集成示例 - OpenCode TUI
<img src="docs/screenshots/CodeDox-1.gif" alt="CodeDox演示" width="800">截图
仪表板
<img src="docs/screenshots/WebUI-Dashboard.webp" alt="CodeDox仪表板" width="800">带高亮显示的Markdown搜索
<img src="docs/screenshots/CodeDoX-WebUI-Markdown-Search.webp" alt="CodeDox Markdown搜索" width="800">源详细视图
<img src="docs/screenshots/WebUI-Source-Detail.webp" alt="CodeDox源详细信息" width="800">文档
贡献
详情请参阅我们的贡献指南。
作者
Chris Scott - chriswritescode.dev
许可证
本项目采用MIT许可证 - 详情见LICENSE文件。