【开源自荐】zread - AI 代码仓库阅读助手 cli+mcp

软件名称

zread

应用平台

cli、mcp

推荐类型

【开发者自荐】

一句简介

Zread 让你和你的 AI 都更懂代码。代码不用看,直接问。连接 Zread.ai,AI 驱动的 GitHub 项目文档。

应用简介

基于zread.ai网站(类似deepwiki),为github仓库使用ai生成在线文档,zread是给开发者用户以及ai使用的工具

把zread网站的功能封装成了cli和mcp供ai agent(claude code、codex、cherry stduio等)调用

zread网站虽然有官方mcp,但是要开通coding plan付费套餐,而且只提供了三个接口

本工具除了能看仓库文档外,还能跟仓库ai对话,只需要登录网站获取账号凭据完全免费,使用的模型是glm-5.1和claude-sonnet-4.6

使用场景

让ai快速了解开源项目整体架构

查看代码api接口如何使用

分析不同的开源库做对比

主要能力

  • :open_book: 阅读文档 - 直接在终端浏览 GitHub 仓库文档

  • :magnifying_glass_tilted_left: 搜索代码 - 在仓库文档中搜索关键词

  • :glowing_star: 发现仓库 - 浏览热门榜单、搜索优质项目

  • :inbox_tray: 导出文档 - 批量导出仓库文档到本地,生成 llms.txt 和 llms-full.txt(CLI 专属)

  • :robot: AI 问答 - 向仓库 AI 助手提问(需登录账号的免费凭据)

  • :page_facing_up: 查看源码 - 读取源代码文件内容

  • :electric_plug: MCP 集成 - 与 AI 助手无缝集成

快速启动

命令行工具

# 使用 uvx 运行
uvx zread

# 或使用 pipx
pipx run zread

MCP 服务器

# stdio 模式
uvx zread mcp

# HTTP 模式
uvx zread mcp http

运行示例

帮助信息
zread -h

zread help
文档目录
zread ls openclaw/openclaw

zread ls
查看文档页
zread cat openclaw/openclaw

zread cat wiki
查看 GitHub 文件
zread cat facebook/react README.md

zread cat github
搜索仓库
zread find ai sandbox

zread find repo
搜索文档
zread find openclaw/openclaw gateway

zread find wiki
热门仓库
zread top

zread top
随机推荐
zread rand agent-skills

zread rand
单轮 AI 提问
zread ai openclaw/openclaw 介绍这个库 简单讲讲

zread ai ask
交互式 AI 对话
zread ai openclaw/openclaw

zread ai chat
导出仓库文档
zread cp openclaw/openclaw

zread cp
MCP HTTP 服务
zread mcp http :8080

zread mcp http

官方网站