ドキュメント検索

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を明示的に提供している場合を除き、有効なライブラリIDを取得するために必ず ctx7 library を最初に呼び出す必要があります。

重要: これらのコマンドを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キー、パスワード、認証情報、個人データ、または独自コードなどの機密情報や機密情報をクエリに含めないでください。

結果フィールド

各結果には以下が含まれます:

• Library ID — Context7互換の識別子 (形式: /org/project)
• Name — ライブラリまたはパッケージ名
• Description — 簡単な説明
• Code Snippets — 利用可能なコード例の数
• Source Reputation — 権威インジケーター (High、Medium、Low、またはUnknown)
• Benchmark Score — 品質インジケーター (100が最高スコア)
• Versions — 利用可能な場合はバージョンのリスト。ユーザーがクエリでバージョンを提供した場合は、これらのバージョンのいずれかを使用してください。形式は /org/project/version です。

選択プロセス

1. クエリを分析して、ユーザーが探しているライブラリ/パッケージを理解する
2. 以下に基づいて最も関連性の高いマッチを選択:
   • クエリへの名前の類似性 (完全一致が優先)
   • クエリの意図に対する説明の関連性
   • ドキュメントカバレッジ (コード例の数が多いライブラリを優先)
   • ソース評判 (HighまたはMediumの評判を持つライブラリをより権威的と考える)
   • ベンチマークスコア (高いほど良い、100が最大)
3. 複数の優れたマッチが存在する場合は、これを認識しながら最も関連性の高いものを進める
4. 優れたマッチが存在しない場合は、これを明確に述べ、クエリの改善を提案する
5. 曖昧なクエリの場合は、最適推測マッチを進める前に明確化をリクエストする

バージョン固有の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") で失敗した場合:

1. ユーザーのContext7クォータが枯渇していることを知らせる
2. より高い制限の認証を提案: ctx7 login
3. 認証できない、または認証を選択しない場合は、トレーニングナレッジから回答し、それが古い可能性があることを明確に注記する

Context7が使用されなかった理由を常にユーザーに伝えます — トレーニングデータに静かにフォールバックしないでください。

よくある間違い

• ライブラリIDは / プレフィックスが必要 — facebook/react ではなく /facebook/react
• 常に最初に ctx7 library を実行 — 有効なIDなしで ctx7 docs react "hooks" は失敗します
• 単語ではなく説明的なクエリを使用 — "hooks" ではなく "React useEffect cleanup function"
• クエリにAPIキー、パスワード、認証情報などの機密情報を含めない