zread-generate 对 zread generate --stdio 做了一层封装,用于无人值守地生成仓库文档。
当一次较长的生成任务因为模型或 API 的瞬时错误中途失败时,这个命令会尝试续跑草稿、自动重试失败页面,并在成功退出前校验最终 .zread/wiki 输出是否完整可用。
在需要生成文档的仓库目录中执行:
pnpm exec zread-generate也可以在任意目录下指定目标仓库:
pnpm exec zread-generate --cwd /path/to/repo增加进程级重试次数:
pnpm exec zread-generate --cwd /path/to/repo --max-runs 10允许 zread 在页面重试耗尽后提交部分 wiki:
pnpm exec zread-generate --cwd /path/to/repo --skip-failed- Node.js 18 或更高版本
- 已安装
zreadCLI,且能在PATH中找到 zread已完成配置,并可正常访问可用的 LLM Provider
- 启动
zread generate --stdio -y。 - 当存在
.zread/wiki/drafts时,自动追加--draft resume。 - 以
done/total格式打印页面进度。 - 当 zread 因页面失败而暂停时,自动发送
retry指令。 - 如果配置了
--skip-failed,页面重试后会在 zread 暴露skip_all等待入口时发送跳过指令。 - 如果进程退出后没有得到有效的当前 wiki,则重新执行整条命令,直到达到
--max-runs。 - 成功前会校验:
.zread/wiki/current必须存在- 当前版本目录必须包含
wiki.json wiki.json中列出的每个页面文件都必须存在- 不应残留
.zread/wiki/drafts目录
命令行参数:
| 参数 | 默认值 | 说明 |
|---|---|---|
--cwd <repo> |
当前目录 | 要生成文档的仓库 |
--max-runs <n> |
5 |
最大进程级尝试次数 |
--retry-delay-ms <ms> |
5000 |
进程级重试之间的等待时间 |
--skip-failed |
关闭 | 向 zread 透传 --skip-failed 并在可用时提交跳过 |
环境变量:
| 变量 | 说明 |
|---|---|
ZREAD_MAX_RUNS |
等同于 --max-runs |
ZREAD_RETRY_DELAY_MS |
等同于 --retry-delay-ms |
ZREAD_SKIP_FAILED=1 |
等同于 --skip-failed |
0:wiki 生成完成,且校验通过1:参数错误,或在配置的重试次数内仍未完成生成127:底层zread无法启动时会作为单次运行结果记录;如果最终仍未成功,命令整体返回1