gread
Original：🇺🇸 English
Translated
Provide the ability to search, inspect, and read source code from all public GitHub repositories and their associated documentation.
3installs
Sourcenitrorcr/gread
Added on
NPX Install
npx skill4agent add nitrorcr/gread greadTags
Translated version includes tags in frontmatterSKILL.md Content
View Translation Comparison →Gread
Provide the ability to search, inspect, and read source code from all public GitHub repositories and their associated documentation.
Endpoints
All endpoints are GET endpoints exposed at . Only use parameters through the query string (). The system returns well-formatted markdown blocks.
https://api.gread.dev?key=value- If the exact repository full name is known (e.g., ), view repository (
owner/repo) directly./repo - Otherwise, search repositories () first to find the correct repository.
/search - To retrieve documents, also view the main repository through ; its corresponding document repo will also be returned (if exists).
/repo
1. Search Repositories
Search for GitHub repositories by name, description, or topic keywords using the GitHub Search API.
Format:
Example:
GET https://api.gread.dev/search?q={keyword}GET https://api.gread.dev/search?q=hono| Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | Keyword to search in repository names, descriptions, or topics |
2. View Repository
View repository basic information and its directory structure. Includes corresponding documentation repo if available.
Format:
Example:
GET https://api.gread.dev/repo?name={user/repo}GET https://api.gread.dev/repo?name=honojs/hono| Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | Full name of the repository (owner/repo) |
3. List Directory Tree
Detailed view of a repository's directory tree with recursion limits.
Format:
Example:
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| Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | Full name of the repository (owner/repo) |
| string | No | Target directory path to inspect (defaults to root if empty) |
| number | No | Maximum depth into the directory structure to list (default:3) |
| number | No | Maximum number of items to display per directory level (default: 40) |
4. Read Code
Retrieve the raw source code of specified files from within a known repository. Provide paths separated by commas.
Format:
Example:
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| Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | Full name of the repository (owner/repo) |
| string | Yes | Comma-separated list of precise file paths within the repository |
5. Search within Repo
Perform a fast inside the repository.
Format:
Example:
git grepGET 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| Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | Full name of the repository (owner/repo) |
| string | Yes | Search pattern or query to pass to git grep |
| boolean | No | Ignore case distinctions ( |
| boolean | No | Interpret pattern as fixed string ( |
| boolean | No | Interpret pattern as extended regular expression ( |
| number | No | Print num lines of output context ( |
| string | No | Directory or file path to limit the search scope |