开源 AI 文档生成器！给代码库做个CT扫描，一键生成交互式Wiki文档！

我们在接收新项目或探索开源代码库时，理解代码结构和功能往往耗时费力，尤其当项目缺乏文档或结构复杂时更是令人头疼。

而复杂代码库通常需要开发者逐行阅读代码、分析 README 或手动绘制架构图，效率低下易出错。

DeepWiki-Open 是由 AsyncFuncAI 开发的开源工具，主打 AI 驱动的代码分析和自动化文档生成，以解决上述痛点。

它将 GitHub 或 GitLab 仓库一键转为交互式 Wiki，生成结构化文档和 Mermaid 图表，让开发者快速掌握项目全貌。

基于 FastAPI（后端）、Next.js（前端）和 RAG 技术。通过分析代码库的结构、文件和 README，生成交互式 Wiki 文档，包含架构图、模块说明和依赖关系。

让每个开发者都能轻松理解代码库。

主要功能

• • 一键生成交互式 Wiki： 自动将 GitHub/GitLab 仓库转为交互式 Wiki 文档
• • 支持私有仓库：支持 Git 私钥配置，安全接入你的企业/私有项目
• • AI 智能分析：利用 LLM 解析模块结构、函数含义、依赖关系等
• • Mermaid 图表可视化： 自动绘制项目模块架构图、函数依赖图（Mermaid.js）
• • 类维基导航结构：文件、模块、类、函数逐层展开，逻辑层次清晰
• • 交互式前端：清爽 UI，支持全文检索、代码预览、图谱浏览

快速上手

DeepWiki Open 支持 Docker 和手动部署，硬件需求适中。

Docker 快速部署

# 1.克隆项目
git clone https://github.com/AsyncFuncAI/deepwiki-open.git
cd deepwiki-open

# 创建环境变量，配置API KEY
echo "GOOGLE_API_KEY=your_google_api_key" > .env
echo "OPENAI_API_KEY=your_openai_api_key" >> .env

# 运行Docker
docker-compose up

本地手动部署

同样克隆项目到本地，准备好谷歌和OpenAI的API Key。

① 运行后端服务

# 安装Python项目依赖
pip install -r api/requirements.txt

# 启动API服务
python -m api.main

② 运行前端服务

# 安装 JS 依赖
npm install
# or
yarn install

# 启动Web服务
npm run dev
# or
yarn dev

然后打开 http://localhost:3000，输入仓库 URL。

对于私有仓库需点击“+ Add access tokens”，输入 GitHub/GitLab 个人访问令牌。

然后点击“Generate Wiki”，AI 分析后生成文档和图表。

适用人群

• • 开发者：快速熟悉新项目结构，少走弯路
• • 学习者：阅读大型开源项目更高效，理解各模块作用
• • 维护者：便于生成文档、交流设计意图、交接代码
• • 团队协作：替代传统文档系统，一处同步维护代码与文档

写在最后

拿到一个新项目，我最怕的是：一大堆 .py / .ts / .go 文件，深得像迷宫，函数和类飞来飞去，全靠人肉 grep。

更糟的是：没有文档、没有注释、没人愿意解释。

这不是我一个人的痛点，而是几乎所有程序员在接手新项目时的共鸣。

而现在有了 DeepWiki-Open，帮助我们把晦涩代码变成可视知识地图！

把任何 GitHub / GitLab 仓库一键转换为交互式 Wiki，自动生成架构图、流程图、代码说明，像看文档一样看懂整个项目。

如果你经常要读别人写的代码，如果你恨过“这代码谁写的？”—那么 DeepWiki-Open 可以值得一试。

GitHub 项目地址：https://github.com/AsyncFuncAI/deepwiki-open