AI导哈

文档搜索与代码提取工具

CodeDox是一款AI驱动的文档搜索与代码提取工具，能够将任何文档网站转化为可搜索的代码数据库，并提供快速的全文搜索和AI增强的代码提取功能。

  • by chriswritescode-dev
  • Python
  • 本地部署
  • 30 星标
  • 更新于
在 GitHub 查看 chriswritescode-dev/codedox

使用说明

CodeDox-基于AI的文档搜索和代码提取

将任何文档站点转换为可搜索的代码数据库 -CodeDox抓取文档网站，智能提取带有上下文的代码片段，并通过PostgreSQL全文搜索和MCP（模型上下文协议）集成为AI助手提供闪电般快速的搜索。

📚 文档

有关完整文档、安装指南、API参考资料及更多信息，请访问：

https://chriswritescode-dev.github.io/codedox/

快速开始

Docker安装程序（推荐）

# 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

手动安装

请参阅 完整安装指南 详细说明。

主要特点

  • 智能网络爬行：具有URL模式过滤和域限制的深度控制爬行
  • 智能代码提取：双模式提取（自动标题/描述或LLM生成的标题和描述）
  • 增强搜索模式：标准代码搜索，带有智能markdown回退功能，可获得全面的结果
  • 闪电快速搜索：PostgreSQL模糊匹配全文搜索
  • GitHub存储库处理：使用完整路径支持从GitHub存储库克隆和提取文档（例如。， /tree/main/docs)
  • HTTP优先MCP集成：通过HTTP端点使用支持流式HTTP传输的MCP工具（MCP 2025-03-26规范）
  • 完整文档访问权限：从任何文档页面获取完整的markdown内容以获取完整的上下文
  • 现代网络仪表板：用于可视化管理的React+TypeScript UI
  • 版本支持：跟踪文档的多个版本
  • 实时监控：实时爬行进度和健康监测
  • 上传支持：直接或从GitHub存储库上传文档（对于具有文档站点的存储库很有用）

演示-MCP集成示例-OpenCode TUI

截图

仪表盘

带突出显示的Markdown搜索

源详细信息视图

文档

贡献

查看我们的 贡献指南 有关如何为CodeDox做出贡献的详细信息。

作者

当地警官司考特 - chriswritescode.dev

许可证

此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。

相关 MCP