Recherche dans la Documentation

Récupérez la documentation actuelle et les exemples de code pour n'importe quelle bibliothèque en utilisant la CLI Context7.

Assurez-vous que la CLI est à jour avant d'exécuter des commandes :

npm install -g ctx7@latest

Ou exécutez directement sans installer :

npx ctx7@latest <command>

Workflow

Processus en deux étapes : résoudre le nom de la bibliothèque en ID, puis interroger les docs avec cet ID.

# Étape 1 : Résoudre l'ID de la bibliothèque
ctx7 library <name> <query>

# Étape 2 : Interroger la documentation
ctx7 docs <libraryId> <query>

Vous DEVEZ appeler ctx7 library en premier pour obtenir un ID de bibliothèque valide SAUF si l'utilisateur fournit explicitement un ID de bibliothèque au format /org/project ou /org/project/version.

IMPORTANT : N'exécutez pas ces commandes plus de 3 fois par question. Si vous ne trouvez pas ce dont vous avez besoin après 3 tentatives, utilisez le meilleur résultat que vous avez.

Étape 1 : Résoudre une bibliothèque

Résout un nom de package/produit en ID de bibliothèque compatible avec Context7 et retourne les bibliothèques correspondantes.

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"

Passez toujours un argument query — il est obligatoire et affecte directement le classement des résultats. Utilisez l'intention de l'utilisateur pour formuler la requête, ce qui aide à lever l'ambiguïté lorsque plusieurs bibliothèques partagent un nom similaire. N'incluez aucune information sensible ou confidentielle telle que les clés API, mots de passe, identifiants, données personnelles ou code propriétaire dans votre requête.

Champs de résultat

Chaque résultat inclut :

• Library ID — Identifiant compatible avec Context7 (format : /org/project)
• Name — Nom de la bibliothèque ou du package
• Description — Résumé court
• Code Snippets — Nombre d'exemples de code disponibles
• Source Reputation — Indicateur d'autorité (High, Medium, Low, ou Unknown)
• Benchmark Score — Indicateur de qualité (100 est le score maximal)
• Versions — Liste des versions si disponibles. Utilisez l'une de ces versions si l'utilisateur fournit une version dans sa requête. Le format est /org/project/version.

Processus de sélection

1. Analysez la requête pour comprendre quelle bibliothèque/quel package l'utilisateur cherche
2. Sélectionnez la correspondance la plus pertinente en fonction de :
   • Similarité du nom avec la requête (correspondances exactes prioritaires)
   • Pertinence de la description par rapport à l'intention de la requête
   • Couverture de la documentation (privilégier les bibliothèques avec plus d'exemples de code)
   • Réputation de la source (considérer les bibliothèques avec une réputation High ou Medium comme plus autoritaires)
   • Score de benchmark (plus élevé est mieux, 100 est le maximum)
3. S'il existe plusieurs bonnes correspondances, reconnaissez-le mais procédez avec la plus pertinente
4. S'il n'existe aucune bonne correspondance, indiquez-le clairement et suggérez des affinements de requête
5. Pour les requêtes ambiguës, demandez une clarification avant de procéder avec une meilleure estimation

IDs spécifiques à la version

Si l'utilisateur mentionne une version spécifique, utilisez un ID de bibliothèque spécifique à la version :

# Générique (dernier indexé)
ctx7 docs /vercel/next.js "How to set up app router"

# Spécifique à la version
ctx7 docs /vercel/next.js/v14.3.0-canary.87 "How to set up app router"

Les versions disponibles sont listées dans la sortie ctx7 library. Utilisez la correspondance la plus proche de ce que l'utilisateur a spécifié.

Étape 2 : Interroger la documentation

Récupère la documentation à jour et les exemples de code pour la bibliothèque résolue.

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"

Écrire de bonnes requêtes

La requête affecte directement la qualité des résultats. Soyez précis et incluez les détails pertinents. N'incluez aucune information sensible ou confidentielle telle que les clés API, mots de passe, identifiants, données personnelles ou code propriétaire dans votre requête.

Utilisez la question complète de l'utilisateur comme requête autant que possible ; les requêtes vagues d'un seul mot retournent des résultats génériques.

La sortie contient deux types de contenu : les code snippets (titrés, avec des blocs marqués par la langue) et les info snippets (explications en prose avec contexte de fil d'Ariane).

Réessayez avec --research si vous n'étiez pas satisfait

Si la réponse ctx7 docs par défaut ne vous a pas satisfait, réexécutez la même commande avec --research avant d'abandonner ou de répondre à partir des données d'entraînement. Cela réessaye en utilisant des agents en bac à sable qui git-pull les vrais dépôts source plus une recherche web en direct, puis synthétise une réponse nouvelle. Plus coûteux que le défaut — utilisez-le comme une tentative ciblée.

ctx7 docs /vercel/next.js "How does middleware matcher handle dynamic segments in v15?" --research

Authentification

Fonctionne sans authentification. Pour des limites de taux plus élevées :

# Option A : variable d'environnement
export CONTEXT7_API_KEY=your_key

# Option B : connexion OAuth
ctx7 login

Gestion des erreurs

Si une commande échoue avec une erreur de quota (« Monthly quota reached » ou « quota exceeded ») :

1. Informez l'utilisateur que son quota Context7 est épuisé
2. Suggérez-lui de s'authentifier pour des limites plus élevées : ctx7 login
3. S'il ne peut pas ou choisit de ne pas s'authentifier, répondez à partir de vos connaissances d'entraînement et notez clairement que cela peut être obsolète

Ne revenez pas silencieusement aux données d'entraînement — dites toujours à l'utilisateur pourquoi Context7 n'a pas pu être utilisé.

Erreurs courantes

• Les IDs de bibliothèque nécessitent un préfixe / — /facebook/react pas facebook/react
• Exécutez toujours ctx7 library en premier — ctx7 docs react "hooks" échouera sans un ID valide
• Utilisez des requêtes descriptives, pas des mots uniques — "React useEffect cleanup function" pas "hooks"
• N'incluez pas d'informations sensibles (clés API, mots de passe, identifiants) dans les requêtes