它到底是什么

一句话:用 AI 给任意 Git 仓库自动生成可浏览的 Wiki 文档。

你有没有过这种经历:打开一个陌生的 GitHub 仓库,README 写了三行字,目录结构一团乱,想搞清楚这个项目到底干了什么、怎么跑起来的——结果花了俩小时还在迷路。

DeepWiki-Open 就是来解决这个问题的。你丢一个 GitHub 链接进去,它几秒钟帮你生成一份完整的项目 Wiki:模块说明、架构图、数据流图,全都自动搞定。还能用 RAG 对着代码直接提问。

支持 GitHub、GitLab、Bitbucket 三个平台。你输入仓库 URL,它会:

整个过程全自动,用户只需要粘贴一个链接。

解决的核心痛点

开发者面对不熟悉的代码库,传统做法无非几种:

方式问题
读 README很多项目 README 就三行,信息量约等于零
翻目录结构大项目几百个文件,根本理不清依赖关系
搜文档站开源项目的文档经常过时或者根本没有
直接读代码最准但最慢,一个下午可能只搞懂一个模块

DeepWiki 的思路是:让 AI 先把整个仓库读一遍,然后把理解结果组织成结构化文档给你看。它不是替代 README,而是给整个代码库做一次"全身 CT"。

技术架构拆解

前端:Next.js 15

前端用 Next.js 15.3 + React 19 + TypeScript + Tailwind CSS 4。几个关键依赖:

后端:Python FastAPI

后端是 FastAPI + Uvicorn,核心模块:

向量搜索用的 FAISS(faiss-cpu),embedding 模型通过 Google 或 OpenAI 的 API。LLM 客户端支持:OpenAI、Google Gemini、Ollama、OpenRouter、Azure AI、AWS Bedrock、阿里 DashScope、LiteLLM。

数据处理流程

用户输入 Repo URL
    ↓
Clone 仓库(支持 Private Repo + Token)
    ↓
按 repo.json 规则过滤文件
    ↓
代码切片 → 向量嵌入 → 存入 FAISS 索引
    ↓
LLM 分析每个模块 → 生成文档
    ↓
LLM 分析模块关系 → 生成 Mermaid 架构图
    ↓
组装 Wiki 页面 → WebSocket 流式推送到前端

三个核心功能

1. Wiki 生成

主功能。生成的 Wiki 包含项目概览、模块文档、自动 Mermaid 架构图和数据流图。图表支持缩放、拖拽,支持导出。

2. Ask(RAG 问答)

Wiki 旁边有聊天框,可以对着代码库直接提问。底层是 RAG:先用 FAISS 检索相关代码片段,再喂给 LLM 生成回答。支持对话历史,可以追问。

3. Deep Research(深度研究)

2.0 新加的功能。针对复杂问题做多轮迭代研究(最多 5 轮):制定计划 → 检索分析 → 更新理解 → 下一轮 → 输出结论。

怎么自己部署

Docker 一键启动

git clone https://github.com/AsyncFuncAI/deepwiki-open.git
cd deepwiki-open

# 配置 API Key
echo "GOOGLE_API_KEY=*** > .env
echo "OPENAI_API_KEY=*** >> .env

# 启动
docker-compose up

起来之后访问 http://localhost:3000,前端 3000 端口,API 8001 端口。

Docker Compose 会自动挂载 ~/.adalflow 目录做持久化,内存限制 6GB。

如果不想用 OpenAI,可以只配 GOOGLE_API_KEY 用 Gemini。也可以接 Ollama 跑本地模型,零 API 成本。

关键环境变量

变量说明
GOOGLE_API_KEYGemini 模型(默认)
OPENAI_API_KEYOpenAI 模型 + Embedding
OPENROUTER_API_KEYOpenRouter 多模型路由
OPENAI_BASE_URL自定义 OpenAI 兼容端点
DEEPWIKI_AUTH_MODE设为 true 开启访问密码
DEEPWIKI_AUTH_CODE访问密码

适用场景

和同类工具对比

工具特点DeepWiki 的优势
GitHub Copilot ChatIDE 内即时问答生成持久化可浏览的 Wiki
Sourcegraph Cody代码搜索 + 补全专注文档生成 + 架构图可视化
Mintlify / Readme.io文档托管平台那些要手写,DeepWiki 全自动
直接读 README信息量取决于作者覆盖整个代码库

DeepWiki vs DeepWiki-Open

两个东西都叫 DeepWiki:

实际体验的一些坑

总结

DeepWiki-Open 是一个很实用的工具,特别适合需要快速理解陌生代码库的场景。17K Star 不是白来的——它确实解决了真实痛点。自建部署门槛不高,Docker 一把梭。

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

在线体验:deepwiki.com