3 月 31 日,Claude Code 源码泄露事件在技术圈引发热议。我第一时间拿源码,并做了系统化分析。
这篇文章带你:如何用 zread 快速读懂一个复杂工程。
1. 事件回顾:源码是如何泄露的
这部分我在上一篇已经完整写过,可先阅读:
《刚刚,Claude Code 的源码泄露了》
mp.weixin.qq.com/s/fqBsPntEk…
2. 为什么用 zread 分析源码
面对大型代码库,真正困难的往往不是“看代码”,而是“建立全局认知”。
拿到泄露源码后,我选择用 zread 作为第一分析入口,原因很直接:
- 能先生成结构化文档,再进入细节
- 能把“读代码”变成稳定流程,而不是到处跳文件
- 能为后续 AI 问答提供清晰上下文
2.1 zread 是什么
zread 是智谱 AI 推出的代码阅读与理解工具,定位很明确:
在本地项目目录中生成文档,帮助开发者快速理解复杂代码库。
官方说明中,zread 是默认入口命令:进入项目目录后直接运行 zread,CLI 会根据当前状态推荐下一步操作(登录、生成文档、打开文档等)。
它尤其适合这些场景:
- 快速理解代码结构
- 沉淀项目基础文档
- 支撑团队 onboarding
- 为 AI 编程工具补齐上下文
3. zread CLI:3 分钟上手
下面是官方给出的最短路径,我按实操顺序整理成了 4 步。
第 1 步:安装 CLI
npm install -g zread_cli
也可使用 Homebrew:
brew tap codegeex/homebrew-tap
brew install zread
第 2 步:配置 LLM
第 3 步:在项目中生成文档
cd repo
zread
第 4 步:在浏览器查看结果
zread browse
生成的项目文档示例:
这个工具能够帮你快速理解一个陌生项目的代码结构,跑一下就能看到整体架构。同时能够让AI Coding工具(Cursor、Claude code),提供更清晰的上下文。
4. 常用命令清单
| 命令 | 功能 |
|---|---|
zread | 默认入口,根据环境推荐下一步 |
zread generate | 为当前目录生成项目文档 |
zread browse | 在浏览器打开已生成文档 |
zread login | 登录账号或配置 API Key |
zread config | 查看或修改 CLI 配置 |
zread update | 更新 CLI |
zread version | 查看当前版本 |
zread --help | 查看完整帮助 |
5. 文档保存在哪里
官方文档给出的目录结构如下:
.zread/
state.json
wiki/
current
versions/
drafts/
可以这样理解:
current:当前可读版本versions:历史版本归档drafts:生成阶段草稿
这套结构很适合团队协作:文档跟代码同仓、同生命周期,便于共享与回溯。
6. 写在最后
这次实操下来,我最大的感受是:
zread把“读代码”这件事流程化了。
先生成结构化文档,再沿着模块与数据流逐层下钻,最后结合问答补细节。
对大仓库来说,这比盲目搜索和来回跳转高效很多。
如果你正在做源码学习、团队 onboarding,或者想提升 AI 编程时的上下文质量,zread CLI 值得亲自跑一遍。
相关链接
- zread CLI 文档:zread.ai/cli