ejfkdev/zread
Developer toolsこのページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。 原文を見る
GitHub プロジェクトドキュメント(非公式ツール)を閲覧するための、AI 搭載 CLI および MCP サーバー
概要
Zreadは、あなたのAIがコードベースをより速く理解するのに役立ちます。 マニュアルソースのダイビングをスキップし、直接お問い合わせください。 GitHubプロジェクトドキュメントサービスであるZread.aiに接続します。 - OBD️ - 最小限のセットアップでターミナルで直接実行 - 🔌 - ClaudeやClineなどのAIアシスタントと統合 - 匿名のドキュメントをブラウズし、コードを検索し、トークンなしでリポジトリを発見する - リポジトリのドキュメントによって供給される 匿名のAI Q&A - 複数の輸送: stdio、HTTP、およびSSE - ⚡ 1コマンドを実行し、ゼロフリクションスタートアップ - ̇ - GitHubリポジトリのドキュメントをターミナルで直接参照 - リポジトリの文書を渡る検索キーワード - Mackerel - トレンドランキングと推奨プロジェクトを閲覧 - - - - - - - リポジトリのドキュメントをローカルにエクスポートし、llms.txtとllms-fullを生成します.
概要（AI 翻訳）
日本語 | English
Zreadは、あなたのAIがコードベースをより速く理解するのに役立ちます。 マニュアルソースのダイビングをスキップし、直接お問い合わせください。 GitHubプロジェクトドキュメントサービスであるZread.aiに接続します。
2つの役割:
- OBD️ CLIツール - 最小限の設定で端末に直接実行
- 🔌MCPサーバー - クラウデやクラインなどのAIアシスタントと統合
ハイライト:
- ANSI ドキュメントをブラウズし、コードを検索し、トークンなしでリポジトリを発見する
- リポジトリの文書化によるAI Q&A
- 複数のトランスポート: stdio、HTTP、SSE
- ⚡ 実行する1つのコマンド、ゼロフリクション起動
##特徴
- ̇Read docs - GitHubリポジトリのドキュメントをターミナルに直接参照
- ANSI Search docs - リポジトリのドキュメント全体でキーワードを検索する
- ◀Discover repos - トレンドランキングと推奨プロジェクトを参照
- [
llms.txt]と[llms-full.txt]をローカルにリポジトリのドキュメントをエクスポートし、llms-full.txtを生成します。 (CLIのみ) - ✓AI Q&A** - リポジトリAIアシスタント質問(無料のアカウントトークンが必要です)
- ソースファイルの内容を直接検査する
- 🔌MCPの統合 - AIアシスタントとシームレスに接続
スクリーンショット
このページは AI により自動翻訳されています。技術的な詳細は原文をご確認ください。
README
以下は原文 README の抜粋です。原文を見る。
Zread - AI Repository Reading Assistant
中文 | English
Zread helps you and your AI understand codebases faster. Skip the manual source dive and ask directly. It connects to Zread.ai, an AI-powered GitHub project documentation service.
Two roles:
- 🖥️ CLI tool - run directly in your terminal with minimal setup
- 🔌 MCP server - integrate with AI assistants such as Claude and Cline
Highlights:
- 🔍 Browse docs, search code, and discover repositories without a token
- 🤖 AI Q&A powered by repository documentation
- 🌐 Multiple transports: stdio, HTTP, and SSE
- ⚡ One command to run, zero-friction startup
Features
インストール
uvx --env ZREAD_TOKEN=your-token zread mcp設定
{
"mcpServers": {
"zread": {
"command": "uvx",
"args": ["--env", "ZREAD_TOKEN=your-token", "zread", "mcp"]
}
}
}