用途:zread 是一个命令行工具,利用 LLM 根据当前工作区代码生成 wiki 文档,输出存放在工作区的 ./.zread/wiki/ 目录;公开仓库也可在 https://zread.ai 查看。该技能面向智能体使用,建议直接从磁盘读取生成的文件,并对所有命令默认使用 --stdio 模式,而非解析人类 TUI。
主要能力与磁盘布局:在成功生成后,./.zread/wiki/current 是记录活动版本 id 的文本文件;./.zread/wiki/versions/<id>/wiki.json 为目录(含 pages 的 slug、title、file 等);pages[*].file 引用对应的 Markdown 页面;./.zread/wiki/drafts/ 表示进行中或未完成的生成,drafts/wiki.json 在目录阶段完成后存在;~/.zread/config.yaml 为全局配置,~/.zread/login.json 表示已登录。
使用方式:应始终在工作区根目录运行 zread。命令包括 zread generate(生成 wiki,支持 -y、--draft resume|clear|cancel、--skip-failed、--stdio)、zread browse(本地服务并打开浏览器,支持 --generate、--version、--host、--port)、zread login(OAuth 登录 BigModel/Z.AI 获取密钥)、zread config、zread update、zread version。所有命令均支持 --stdio,将其转为 stdin/stdout 的 JSON 行协议。非交互运行需传 -y,并显式设置 --draft 以避免提示。日志位于 ~/.zread/log/zread.log。
适用场景与限制:适用于读取或(重新)生成代码库 wiki、在浏览器查看文档、以脚本或智能体方式驱动 zread。限制与注意:generate 会消耗 LLM 令牌并有真实成本,大仓库可能运行很久,需先获得用户确认;生成只写入 ./.zread/,不会提交到 git;update 会原地替换二进制且难以回退,仅在用户明确要求时运行;login 会打开浏览器,非交互环境不应运行。资料未提供定价、模型细节与具体效果。