概述
我基于 zread.ai 的公开 API，用 TypeScript 写了一个 CLI 工具——zread-docs-cli，用于浏览和导出 zread.ai 上已生成的仓库文档。
它与 zread CLI 的功能定位互补：
|
zread CLI（官方） |
zread-docs-cli（社区） |
| 功能 |
生成文档（本地代码 → AI Wiki） |
浏览/导出 zread.ai 上已生成的文档 |
| 需要登录 |
是（订阅账号） |
否（读取操作免认证） |
| 典型场景 |
我想给新项目生成文档 |
我想在终端快速查阅某个开源项目的文档 |
功能
zread-docs find react # 搜索仓库
zread-docs stat facebook/react # 查看仓库信息
zread-docs ls facebook/react # 列出文档目录
zread-docs cat facebook/react 1-overview # 阅读指定页面
zread-docs cp facebook/react ./docs # 批量导出所有页面（含 llms.txt / llms-full.txt）
技术细节
- 语言：TypeScript（Node.js >= 18），纯
fetch API，无额外 HTTP 依赖
- 协议：通过 zread.ai 的公开端点读取 RSC（React Server Component）响应流，解析二进制分帧格式提取 Markdown
- 认证：
find、stat、ls、cat、cp 等读取命令不需要任何 token，开箱即用
协作意愿
如果官方团队认为这个工具有价值，我愿意将其纳入官方维护。具体方式可以讨论：
- 仓库转移：将
yamsfeer/zread-docs-cli 转移给 ZreadAI 组织，我保留 maintainer 权限继续维护
- 独立推荐：保持社区独立项目，官方在文档/网站中作为推荐工具列出
- 其他方式：完全尊重官方团队的决策
期待官方的反馈！
概述
我基于 zread.ai 的公开 API，用 TypeScript 写了一个 CLI 工具——zread-docs-cli，用于浏览和导出 zread.ai 上已生成的仓库文档。
它与 zread CLI 的功能定位互补：
功能
技术细节
fetchAPI，无额外 HTTP 依赖find、stat、ls、cat、cp等读取命令不需要任何 token，开箱即用协作意愿
如果官方团队认为这个工具有价值，我愿意将其纳入官方维护。具体方式可以讨论：
yamsfeer/zread-docs-cli转移给ZreadAI组织，我保留 maintainer 权限继续维护期待官方的反馈！