DeepV-Ki
AI一键生成代码仓库交互式Wiki,支持架构分析、代码RAG问答和Ollama本地模型
加载项目详情…
本应用为开源项目,仅供学习研究,请遵守其开源协议。
AI一键生成代码仓库交互式Wiki,支持架构分析、代码RAG问答和Ollama本地模型
加载项目详情…
本应用为开源项目,仅供学习研究,请遵守其开源协议。
每个开发者都知道代码文档是个难题:写代码时顾不上,写完代码懒得补,时间一长连自己都看不懂当初的设计思路。更别说接手别人的项目——没有文档的情况下,光是理解一个中型仓库的架构和关键模块,就需要花上几天时间。
DeepV-Ki 解决的是这个问题:给它一个代码仓库,它帮你生成一整套 Wiki 文档。不是简单的 README 模板,而是包含架构分析、模块关系图、代码问答(基于 RAG)、自动生成的 API 文档。它背后的团队 OrionStarAI 正是希望让"文档生成"这件事从负担变成自动化的副产品。
DeepV-Ki 定位是 AI-Powered Wiki Generator for Code Repositories,GitHub 298 stars,由 OrionStarAI 团队维护。项目采用 Python 3.11+ 后端 + Next.js 15 前端的双服务架构,部署方式支持 docker-compose 一键启动,以及专门面向 Ollama 本地模型的独立 Dockerfile。
核心依赖包括 adalflow(RAG 框架)、FastAPI、FAISS(向量数据库)、Celery(异步任务队列)、Playwright(网页渲染)等。
架构分析与图谱生成:DeepV-Ki 会对仓库进行深度静态分析,提取模块间的依赖关系,生成架构图谱。这不是简单的目录树,而是基于实际 import/export 关系的有向图,帮助开发者快速理解代码组织。
RAG 代码问答:基于 adalflow 构建的 RAG 管道,对仓库代码进行分块、向量化后存入 FAISS 向量库。用户可以用自然语言提问,系统检索相关代码片段并生成回答。这解决了"代码搜索"的问题——不用记住具体的类名或函数名,用描述性的语言就能找到相关代码。
多模型支持:支持 OpenAI、Google Gemini、Ollama 本地模型。其中 Ollama 支持是一个亮点:提供专门的 Dockerfile-ollama-local,内置下载 nomic-embed-text(Embedding 模型)和 qwen3:1.7b(问答 LLM),无需任何 API key 即可完全离线运行。
代码文档生成:自动生成模块级别的 API 文档,支持 Markdown 格式导出。Playwright 用于渲染和截图,确保生成的文档在视觉上一致。
后端 API 基于 FastAPI + Celery(Redis 作为消息队列),支持 GitLab 远程仓库拉取、Azure AI 集成、S3 存储等企业级功能。数据库使用 SQLAlchemy,支持多种 SQL 后端。前端 Next.js 15 提供交互式 Wiki 浏览界面。
Docker Compose 部署配置了健康检查(/health 端点)和内存限制(mem_limit: 6g),对资源使用有合理控制。
Ollama 本地化部署:Dockerfile-ollama-local 是这个项目最实用的设计。它解决了企业内网或隐私敏感场景下无法使用云端 API 的问题,内置两个量化后的模型,无需配置任何外部依赖即可跑起来。
adalflow RAG 框架:项目使用 adalflow(一个轻量级 RAG 框架)作为检索管道,相比 LangChain 的"大而全",adalflow 更专注于 RAG 场景的端到端优化。
多架构支持:Dockerfile-ollama-local 明确支持 amd64 和 arm64 两种架构,覆盖了 x86 服务器和 Apple Silicon (M1/M2) 的使用场景。
前端依赖 Playwright:架构图生成功能依赖 Playwright 截图,如果 Docker 环境中没有正确配置浏览器,可能导致部分功能失效。
部署复杂度:Celery + Redis 的异步任务架构增加了运维复杂度,对于只是想简单体验的用户来说,启动 4 个容器(API + Celery worker + Redis + 前端)的配置比一般的 Flask 应用要重。
中文文档质量:README 有中文版本,但与英文版本内容存在差异,部分章节翻译不完整。
DeepV-Ki 精准地瞄准了"代码仓库文档化"这个痛点,提供从架构分析到 RAG 问答的完整工具链。docker-compose 部署简单,Ollama 版本提供了零配置的离线方案,适合需要为内部代码仓库生成文档的团队。