Provide the ability to search, inspect, and read source code from all public GitHub repositories and their associated documentation.
All endpoints are GET endpoints exposed at
. Only use parameters through the query string (
). The system returns well-formatted markdown blocks.
Search for GitHub repositories by name, description, or topic keywords using the GitHub Search API.
Format:
GET https://api.gread.dev/search?q={keyword}
Example:
GET https://api.gread.dev/search?q=hono
View repository basic information and its directory structure. Includes corresponding documentation repo if available.
Format:
GET https://api.gread.dev/repo?name={user/repo}
Example:
GET https://api.gread.dev/repo?name=honojs/hono
Detailed view of a repository's directory tree with recursion limits.
Format:
GET https://api.gread.dev/tree?name={user/repo}&dir={targetDir}&depth={num}&limit={num}
Example:
GET https://api.gread.dev/tree?name=honojs/hono&dir=src&depth=3&limit=50
Retrieve the raw source code of specified files from within a known repository. Provide paths separated by commas.
Format:
GET https://api.gread.dev/read?name={user/repo}&paths={path1,path2}
Example:
GET https://api.gread.dev/read?name=honojs/hono&paths=src/index.ts,package.json