Zread
帮助开发者理解 GitHub 仓库并生成本地项目文档的 AI 代码知识工具。
工具介绍
Zread 是面向开发者的 AI 代码知识工具，主要用于探索和理解 GitHub 仓库。它提供多语言指南、架构解读及与仓库相关的社区信息，适合阅读陌生项目、了解项目结构。除了网页上的仓库探索能力，Zread 还提供用于跟踪仓库更新的订阅功能；开发者也可以通过 CLI 从本地项目生成文档，或通过 MCP 让兼容的 AI 助手检索仓库文档、结构和文件内容。
核心功能
- 仓库知识导览：提供 GitHub 仓库的多语言指南、架构解读和社区相关信息，辅助理解项目。
- 仓库更新跟踪：订阅指定仓库，跟踪其后续更新。
- 本地项目文档生成：使用 CLI 为本地项目目录生成项目文档，并可在浏览器中打开。
- AI 助手仓库检索：通过 MCP，让兼容的 AI 助手搜索仓库文档、查看目录结构及读取单个文件内容。
使用方法
- 1在本地项目目录中运行 Zread CLI 的默认命令 zread，查看它针对当前项目状态给出的下一步提示。
- 2需要创建项目文档时，在该目录运行 zread generate。
- 3运行 zread browse，在浏览器中打开生成的文档，阅读项目内容。
常见问题
Zread 能帮助理解 GitHub 仓库的哪些内容？
它提供多语言仓库指南、架构解读和社区相关信息，帮助开发者探索和理解仓库。
能用 Zread 为本地项目生成文档吗？
可以。Zread CLI 可从本地项目目录生成文档；在该目录运行 zread generate 后，可运行 zread browse 在浏览器中打开生成的文档。
Zread 如何配合 AI 助手阅读代码仓库？
Zread MCP 向兼容 MCP 的 AI 助手提供仓库检索能力，包括搜索仓库文档、查看仓库或子目录结构，以及读取单个文件的完整内容。
可以用 Zread 跟踪仓库更新吗？
可以。Zread 提供仓库订阅功能，用于跟踪所订阅仓库的更新。
是否提供手机客户端？
当前核实的是网页、MCP 和本地项目 CLI；应用商店同名 EPUB 阅读器不是本工具，不据此增加 iOS 或 Android 选项。
目前的收费方式是什么？
公开仓库探索和阅读可在网页免费使用；Zread MCP 属于 GLM Coding Plan 订阅权益，按套餐额度调用，不把付费 MCP 写成不限量免费。
