gread

Gread

提供搜索、检查和读取所有公开 GitHub 仓库及其相关文档的能力。

端点

所有端点均为 GET 端点，托管于 https://api.gread.dev。参数只能通过查询字符串传递（?key=value）。系统会返回格式良好的 Markdown 块。

• 如果已知确切的仓库全名（例如 owner/repo），请直接查看仓库（/repo）。
• 否则，请先搜索仓库（/search），以找到正确的仓库。
• 要获取文档，也请通过 /repo 查看主仓库；如果存在对应的文档仓库，也会一并返回。

1. 搜索仓库

使用 GitHub Search API，按名称、描述或主题关键词搜索 GitHub 仓库。 格式：GET https://api.gread.dev/search?q={keyword} 示例：GET https://api.gread.dev/search?q=hono

参数	类型	必填	说明
q	string	是	用于搜索仓库名称、描述或主题的关键词

2. 查看仓库

查看仓库的基本信息和目录结构。如果有对应的文档仓库，也会一并显示。 格式：GET https://api.gread.dev/repo?name={user/repo} 示例：GET https://api.gread.dev/repo?name=honojs/hono

参数	类型	必填	说明
name	string	是	仓库的全名（owner/repo）

3. 列出目录树

详细查看仓库的目录树，并限制递归深度。 格式：GET https://api.gread.dev/tree?name={user/repo}&dir={targetDir}&depth={num}&limit={num} 示例：GET https://api.gread.dev/tree?name=honojs/hono&dir=src&depth=3&limit=50

参数	类型	必填	说明
name	string	是	仓库的全名（owner/repo）
dir	string	否	要检查的目标目录路径（为空时默认为根目录）
depth	number	否	要列出的目录结构最大深度（默认值：3）
limit	number	否	每个目录层级最多显示的项目数（默认值：40）

4. 读取代码

从已知仓库中获取指定文件的原始源代码。路径之间用逗号分隔。 格式：GET https://api.gread.dev/read?name={user/repo}&paths={path1,path2} 示例：GET https://api.gread.dev/read?name=honojs/hono&paths=src/index.ts,package.json

参数	类型	必填	说明
name	string	是	仓库的全名（owner/repo）
paths	string	是	仓库中精确文件路径的逗号分隔列表

5. 在仓库中搜索

在仓库中快速执行 git grep。 格式：GET https://api.gread.dev/grep?name={user/repo}&q={search_pattern}&i=true&F=true&E=true&C=2&path={targetDir} 示例：GET https://api.gread.dev/grep?name=honojs/hono&q=listen&C=2&path=src

参数	类型	必填	说明
name	string	是	仓库的全名（owner/repo）
q	string	是	传递给 git grep 的搜索模式或查询内容
i	boolean	否	忽略大小写区别（-i）
F	boolean	否	将模式解释为固定字符串（-F）
E	boolean	否	将模式解释为扩展正则表达式（-E）
C	number	否	输出上下文行数（-C）
path	string	否	用于限制搜索范围的目录或文件路径