【免费下载链接】CodeWiki[ACL 2026] Open-source framework for holistic, structured repository-level documentation across multilingual codebases项目地址https://gitcode.com/gh_mirrors/co/CodeWiki点击查看免费下载还在为接手一个百万行的代码仓库而头疼翻不完的源码、过时的注释、缺失的架构说明让新人上手动辄几周。CodeWiki 是一款开源的 AI 文档生成框架发表于 ACL 2026只需一条命令它就能读懂整个代码仓库自动为你生成结构化、带架构图的仓库级文档。它支持 Python、Java、C/C 等十余种语言从几千行到百万行级别的代码库都能应对。本指南将带你从零开始快速掌握 CodeWiki 的安装、配置与日常使用。 什么是 CodeWikiAI 驱动的仓库级文档生成器简单说CodeWiki 做三件事读懂代码用静态分析tree-sitter 语法解析 跨文件调用解析构建整个仓库的依赖关系图而不是让 AI 盲目地猜划分模块把庞大的依赖图递归聚类成一棵模块树百万行的仓库也能像一万行的项目一样被拆解逐模块写文档每个叶子模块由一个 AI Agent 阅读真实源码后撰写一个页面父模块和总览页再由子页面自底向上汇总生成并自动校验 Mermaid 架构图。与把整个仓库塞给大模型的做法不同CodeWiki 让 AI 的每一步写作都建立在经过验证的依赖图之上——文档质量因此更稳定也覆盖了 Dockerfile、CI 配置、构建脚本这些传统工具容易忽略的构建与部署内容。 想深入了解整体架构可以阅读项目自带的 docs/overview.md那就是 CodeWiki 给自己生成的文档。CodeWiki 的三阶段工作流① 构建依赖图并递归拆解模块树 → ② 递归 Agent 为每个模块撰写文档 → ③ 自底向上合成完整的仓库文档 快速上手三步安装并生成第一份文档第一步一键安装 CodeWiki环境要求很简单Python 3.12、Git安装时还需要 Node.js 和 npm用于架构图校验。pip install githttps://gitcode.com/gh_mirrors/co/CodeWiki.git codewiki --version第二步配置你的 LLM 供应商CodeWiki 支持 7 种接入方式任选其一即可方式适用场景openai-compatible默认任何 OpenAI 风格的 APIOpenAI、LiteLLM 代理、OpenRouter 等anthropic/azure-openai/bedrock直连 Anthropic、Azure 或 AWS Bedrockclaude-code/codex✅ 已有 Claude 或 Codex 订阅无需 API Key零按量费用atlas-cloud一个 API 背后 300 托管模型最常用的两种配置命令# 方式一API Key任何 OpenAI 兼容端点 codewiki config set \ --provider openai-compatible \ --api-key YOUR_API_KEY \ --base-url https://api.example.com/v1 \ --main-model claude-sonnet-4 \ --cluster-model claude-sonnet-4 # 方式二订阅模式先执行 claude login无需 API Key codewiki config set --provider claude-code \ --main-model claude-sonnet-4-6 --cluster-model claude-sonnet-4-6配置完可以用codewiki config validate一键检测连通性。各供应商的详细说明见 guides/providers.md。第三步一条命令生成仓库文档cd /path/to/your/project codewiki generate # 输出到 ./docs 目录 codewiki generate --github-pages # 额外生成可分享的 HTML 静态查看器生成结束后./docs/目录下会得到docs/ ├── overview.md # 仓库总览建议从这里读起 ├── 模块.md # 每个顶层模块一页 ├── 模块/子模块.md # 子模块页面目录结构镜像模块树 ├── module_tree.json # 模块层级结构 ├── metadata.json # 模型、版本、提交号等元信息 └── index.html # 静态查看器加 --github-pages 时生成页面之间用相对链接互相引用每个模块页面还带有自动校验过的 Mermaid 架构图真正做到结构化的仓库级文档。⚙️ 核心能力速览2.0 版本带来了什么增量更新代码变了只更新受影响的页面传统做法是文档过时后推倒重来成本高得吓人。CodeWiki 2.0 的--update模式以组件类、函数、构建文件而非文件为变更单位对比新旧依赖图只为受影响的模块派一个 Agent 打补丁codewiki generate --update # 只刷新变更部分 codewiki generate --compare-to abc123 # CI 场景相对指定提交做增量官方在 svelte约 12.5 万行 JavaScript上的实测全量构建耗时 2 小时 46 分、花费 $21.48而一次提交后的增量更新仅 3 分钟、花费 $0.34。变更太大时它会自动回退到全量构建并如实记录原因。详见 guides/incremental-updates.md。工件感知生成Dockerfile、CI、构建脚本也进文档2.0 起默认开启工件感知Dockerfile、GitHub Actions 工作流、Makefile、package.json、配置文件、Schema 等都会被当作依赖图中的一等公民参与聚类与文档生成并保证输出中有一个Build, Deployment and Configuration模块。构建文件会带有指向其引用代码的边所以文档里的构建与部署章节是真实可追溯的。分类规则与调优方式见 guides/artifact-aware-generation.md。MCP 模式让 IDE 里的 AI 直接帮你写文档如果你已经在用 Cursor、Claude Desktop、Claude Code 或 CodeBuddy可以把 CodeWiki 当作 MCP 服务器接入——CodeWiki 不出 LLM由 IDE 自带的模型负责写作{ mcpServers: { codewiki: { command: codewiki, args: [mcp] } } }然后在 Agent 模式下说一句分析这个仓库并生成 wiki 文档到 docs/即可。MCP 服务端提供依赖分析、代码读取、模块树管理、带 Mermaid 校验的文档写入等 8 个细粒度工具源码位于 codewiki/mcp/。完整指南见 guides/mcp-ide-mode.md。多语言与自定义输出多语言文档codewiki generate --language zh可输出中文文档也支持 ja、vi 等写代码或名称均可标题、表格和图内标注一并翻译范围控制--include *.cs只分析 C# 文件--exclude Tests,Specs跳过测试目录写作导向--focus src/core,src/api聚焦核心目录--doc-type architecture指定架构文档风格--instructions 重点介绍公共 API 和用法示例直接下达写作指令。全部参数一览见 guides/cli-reference.md。 效果如何82 分平均全面领先对比系统官方在 CodeWikiBench 基准7 个真实仓库、486 条评分要求上评估了文档质量同一个 LLM 评委对所有系统打分0–100仓库语言代码行数DeepWikiCodeWiki 2.0WazuhC1,446,73069.9188.14ml-agentsC#86,10675.7489.35logstashJava117,48556.3177.85ElectronC184,23443.9271.59平均65.0682.23规律很清晰改进幅度最大的恰恰是 1.0 版本依赖图最弱的 C/C/Java/C# 仓库22 到 29 分因为这些语言的函数级调用解析在 2.0 中变得作用域/命名空间感知而 Python、JS/TS 等解析器未变动的仓库提升则接近零说明增益确实来自更完整的依赖图。(a) 2.0 相对 1.0 的依赖图扩张倍数(b) 工件分析新增的节点与边(c) 各阶段加权评分对比 项目结构与进阶资源想了解实现细节可以按这些入口阅读源码依赖分析引擎11 种语言解析器 调用图codewiki/src/be/dependency_analyzer/文档生成流水线与更新器codewiki/src/be/documentation_generator.py、codewiki/src/be/updater/命令行入口codewiki/cli/main.pyMCP 服务器与会话管理codewiki/mcp/server.pyCodeWiki 自己生成的完整文档最佳样例docs/浏览器里生成文档项目自带 FastAPI Web 应用输入仓库 URL 即可在页面中异步生成官方提供了 Docker 一键部署方案guides/docker.md。其他常用入口资源说明guides/cli-reference.md所有命令与参数速查guides/providers.md供应商接入与模型选择guides/incremental-updates.md增量更新原理与阈值guides/mcp-ide-mode.mdIDE 内 MCP 驱动生成guides/development.md开发指南管线、新增语言常见问题 FAQQ百万行级别的仓库跑得动吗跑动过。基准测试中的 Wazuh 仓库有 144 万行 C 代码2.0 版本拿到了 88.14 分。大仓库的解析依赖 tree-sitter10 万行以上通常 30 秒内完成静态分析部分。Q费用大概多少费用与仓库规模和变更量成正比。参考 svelte 的实测全量约 $21.48单次提交的增量更新约 $0.34。订阅模式claude-code/codex则无需按 token 付费。Q生成的文档会过时怎么办这正是 2.0 的主打能力——每次代码变更后执行codewiki generate --update它会 diff 依赖图、修复模块树、只为受影响的页面派 Agent 打补丁其余页面一律不动成本只与变更量挂钩。Q小模型生成的文档链接经常出错加--flat参数把所有页面平铺到输出根目录避免相对路径层级问题模块名在全 wiki 中唯一链接依然可达。总结CodeWiki 把给大仓库写文档这件事从人力密集型变成了工程化流程依赖图打底、模块树拆解、AI Agent 逐页撰写、增量更新保鲜。三条命令完成安装、配置、生成一个--update标志让文档始终跟上代码MCP 模式则让 IDE 里的 AI 直接接管写作。无论你面对的是 1 万行的 Python 项目还是百万行的 C 内核级代码库它都能给出一份带架构图、可交叉引用、结构镜像代码组织的仓库级文档。 动手试试吧——先挑一个你正需要交接的项目codewiki generate之后你会发现新人上手指南其实可以一晚上自动写好。赞分享【免费下载链接】CodeWiki[ACL 2026] Open-source framework for holistic, structured repository-level documentation across multilingual codebases项目地址https://gitcode.com/gh_mirrors/co/CodeWiki点击查看免费下载相关推荐AI重构革命SWE-agent自动化百万行代码实践指南AI重构革命SWE agent自动化百万行代码实践指南 SWE agent是一款基于AI的自动化软件工程工具它能够通过Agent Computer InteAI AgentAgent 框架代码智能体后端开发工具如何利用DeepWiki-Open快速为机器学习项目生成专业文档AI驱动代码库文档化完全指南如何利用DeepWiki Open快速为机器学习项目生成专业文档AI驱动代码库文档化完全指南 DeepWiki Open是一个强大的开源AI驱动Wiki生成器AI 应用人工智能RAG文档screw完全指南如何为10数据库自动生成专业文档screw完全指南如何为10数据库自动生成专业文档 还在为数据库文档编写而烦恼吗screw螺丝钉是一个简洁好用的数据库表结构文档生成工具能够帮助开发开发工具文档创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考