gread について
Greadは、公開GitHubリポジトリと関連ドキュメントの検索、閲覧、ソース読み取りを提供し、プロジェクトを調査する開発者向けです。GET APIは整形済みMarkdownを返し、リポジトリ内検索にも対応します。
主な機能
- 01名前やキーワードでリポジトリを検索
- 02リポジトリ情報と構成を表示
- 03ディレクトリツリーを一覧
- 04指定したソースファイルを読み取り
- 05リポジトリ内のコードを検索
活用シーン
- 01公開GitHubプロジェクトを探す
- 02リポジトリ内で実装ファイルを特定
- 03ソースコードやドキュメントを読む
- 04記号や文字列をリポジトリ内で検索
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/インストール後、Claude Code で/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 | いいえ | 検索範囲を限定するディレクトリまたはファイルのパス |