
在要讲解的仓库根目录直接运行生成,不必先把代码拷到别处。若中途停下,再次运行时选择续写草稿,已经写完的页面不会重做。结果放在项目里的维基目录,用浏览命令可在浏览器打开,也能按历史版本回看某一次生成。界面和正文语言可以分开设置。已有智谱订阅时,登录后不必再填密钥;改用其他服务,就在配置里更换提供方或填入兼容接口,并调整并发页数和失败重试。适合要给私有仓库留一份可离线阅读的结构化说明、又不希望源码被传到文档网站的团队。
Zread 是面向本地代码仓库的命令行文档工具,官网为 zread.ai。它用大模型分析当前项目并生成结构化维基,在仓库目录中运行后会进入引导流程。文档写在项目内部,官方说明不会上传到服务器。界面语言和文档语言可以分别设为中文或英文。生成中断后可以选择续写草稿,每次结果都保留历史版本,并能在浏览器中回看。Windows 安装包由智谱发布,也可以改用自备密钥或兼容接口。
使用门槛: 需要一定基础
本地仓库生成维基
在项目目录运行后分析代码语义,生成结构化维基,并保存在仓库内的文档目录中。
中断后续写草稿
生成中断后再次执行生成命令,选择续写草稿即可从停下的位置继续,已完成页面不会重复生成。
浏览器查看历史版本
每次生成都会保留历史版本,浏览命令可以在浏览器打开当前文档,也可以进入版本选择器回看。
自选模型提供方
可登录智谱订阅账号直接使用,也可填写其他服务的密钥,或接入兼容接口的自定义地址。
给私有仓库补内部文档
工程负责人在本机仓库执行生成,把架构和模块说明留在项目内,供同事离线阅读。
中断后继续补完文档
长时间生成被打断时,开发者选择续写草稿,只补未完成的页面,而不是整库重跑。
对照新旧两次说明
代码改过一版后重新生成,再用版本选择器打开上一次维基,对照模块说明有没有跟上改动。
官方常见问题写明,文档保存在项目目录的维基文件夹中,完全本地存储,不会上传到服务器。因此它适合不便把私有仓库交给外部网站索引的团队。阅读时用浏览命令在本机浏览器打开。若要换电脑查看,需要自己拷贝该目录,工具不会提供云端同步。
不用整库重跑。再次执行生成命令并选择续写草稿,会从中断处继续,已完成页面保持原样。每次完整或部分生成还会留下历史版本,之后可以用浏览命令打开版本选择器,对照某一次的目录结构。并发页数和失败重试可以在配置里调整。
可以。配置里除了智谱订阅通道,还列出需自备密钥的其他提供方,也允许填写兼容接口地址。订阅账号的作用是登录后自动取得密钥,免去自己申请。无论哪种方式,都要先完成登录或配置,工具不会在未设置模型来源时直接分析仓库。
来自真实用户的评价和反馈