ドキュメントルックアップ
Context7 CLI を使用して、任意のライブラリに関する最新のドキュメントとコード例を取得します。
コマンドを実行する前に、CLIが最新であることを確認してください。
npm install -g ctx7@latest
または、インストールせずに直接実行することもできます。
npx ctx7@latest <command>
ワークフロー
2段階のプロセス：ライブラリ名をIDに解決し、そのIDでドキュメントをクエリします。
# ステップ1：ライブラリIDの解決
ctx7 library <name> <query>
# ステップ2：ドキュメントのクエリ
ctx7 docs <libraryId> <query>
ユーザーが /org/project または /org/project/version 形式のライブラリIDを明示的に提供した場合を除き、最初に ctx7 library を呼び出して有効なライブラリIDを取得する必要があります。
重要：1つの質問に対してこれらのコマンドを3回以上実行しないでください。3回試行しても必要なものが見つからない場合は、得られた最良の結果を使用してください。
ステップ1：ライブラリの解決
パッケージ/製品名をContext7互換のライブラリIDに解決し、一致するライブラリを返します。
ctx7 library react "How to clean up useEffect with async operations"
ctx7 library nextjs "How to set up app router with middleware"
ctx7 library prisma "How to define one-to-many relations with cascade delete"
常に query 引数を渡してください。これは必須であり、結果のランキングに直接影響します。ユーザーの意図を使用してクエリを形成することで、類似した名前の複数のライブラリを区別するのに役立ちます。APIキー、パスワード、資格情報、個人データ、プロプライエタリコードなどの機密情報や秘密情報をクエリに含めないでください。
結果フィールド
各結果には次のものが含まれます。
- ライブラリID — Context7互換の識別子（形式：
/org/project） - 名前 — ライブラリまたはパッケージ名
- 説明 — 短い概要
- コードスニペット — 利用可能なコード例の数
- ソースの評判 — 信頼性の指標（High、Medium、Low、またはUnknown）
- ベンチマークスコア — 品質の指標（100が最高スコア）
- バージョン — 利用可能なバージョンのリスト。ユーザーがクエリでバージョンを指定した場合は、そのうちの1つを使用します。形式は
/org/project/versionです。
選択プロセス
- クエリを分析して、ユーザーがどのライブラリ/パッケージを探しているかを理解する
- 以下に基づいて最も関連性の高いマッチを選択する：
- クエリとの名前の類似性（完全一致が優先）
- クエリの意図に対する説明の関連性
- ドキュメントのカバレッジ（コードスニペット数が多いライブラリを優先）
- ソースの評判（HighまたはMediumの評判を持つライブラリをより権威があるとみなす）
- ベンチマークスコア（高いほど良い、100が最大）
- 良いマッチが複数ある場合は、そのことを認識しつつも最も関連性の高いもので進める
- 良いマッチが存在しない場合は、そのことを明確に述べ、クエリの改善を提案する
- あいまいなクエリの場合は、最良の推測マッチに進む前に明確化を求める
バージョン固有のID
ユーザーが特定のバージョンに言及した場合は、バージョン固有のライブラリIDを使用します。
# 一般（最新のインデックス）
ctx7 docs /vercel/next.js "How to set up app router"
# バージョン固有
ctx7 docs /vercel/next.js/v14.3.0-canary.87 "How to set up app router"
利用可能なバージョンは ctx7 library の出力にリストされています。ユーザーが指定したものに最も近い一致を使用します。
ステップ2：ドキュメントのクエリ
解決されたライブラリの最新のドキュメントとコード例を取得します。
ctx7 docs /facebook/react "How to clean up useEffect with async operations"
ctx7 docs /vercel/next.js "How to add authentication middleware to app router"
ctx7 docs /prisma/prisma "How to define one-to-many relations with cascade delete"
良いクエリの書き方
クエリは結果の品質に直接影響します。具体的に記述し、関連する詳細を含めてください。APIキー、パスワード、資格情報、個人データ、プロプライエタリコードなどの機密情報や秘密情報をクエリに含めないでください。
| 品質 | 例 |
|---|---|
| 良い | "How to set up authentication with JWT in Express.js" |
| 良い | "React useEffect cleanup function with async operations" |
| 悪い | "auth" |
| 悪い | "hooks" |
可能な場合はユーザーの質問全体をクエリとして使用してください。漠然とした1語のクエリは一般的な結果を返します。
出力には2種類のコンテンツが含まれます：コードスニペット（タイトル付き、言語タグ付きブロック）と情報スニペット（ブレッドクラムコンテキスト付きの散文による説明）です。
認証
認証なしで動作します。より高いレート制限のためには：
# オプションA：環境変数
export CONTEXT7_API_KEY=your_key
# オプションB：OAuthログイン
ctx7 login
エラーハンドリング
コマンドがクォータエラー（「Monthly quota reached」または「quota exceeded」）で失敗した場合：
- ユーザーにContext7のクォータが使い果たされたことを通知する
- 認証で制限を上げることを提案する：
ctx7 login - ユーザーが認証できない、または認証しないことを選択した場合は、トレーニング知識から回答し、それが古い可能性があることを明確に注記する
Context7が使用されなかった理由を常にユーザーに伝え、黙ってトレーニングデータにフォールバックしないでください。
よくある間違い
- ライブラリIDには
/プレフィックスが必要 —/facebook/reactであってfacebook/reactではない - 常に最初に
ctx7 libraryを実行する — 有効なIDなしでctx7 docs react "hooks"を実行すると失敗する - 説明的なクエリを使用し、単一語を使用しない —
"React useEffect cleanup function"であって"hooks"ではない - クエリに機密情報（APIキー、パスワード、資格情報）を含めない