Recherche de Documentation
Récupère la documentation et les exemples de code à jour pour n'importe quelle bibliothèque en utilisant l'interface en ligne de commande Context7.
Assurez-vous que l'interface CLI est à jour avant d'exécuter les commandes :
npm install -g ctx7@latest
Ou exécutez directement sans installer :
npx ctx7@latest <commande>
Workflow
Processus en deux étapes : résoudre le nom de la bibliothèque en un identifiant, puis interroger la documentation avec cet identifiant.
# Étape 1 : Résoudre l'identifiant de la bibliothèque
ctx7 library <nom> <requête>
# Étape 2 : Interroger la documentation
ctx7 docs <libraryId> <requête>
Vous DEVEZ d'abord appeler ctx7 library pour obtenir un identifiant de bibliothèque valide, SAUF si l'utilisateur fournit explicitement un identifiant de bibliothèque au format /org/projet ou /org/projet/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 dont vous disposez.
Étape 1 : Résoudre une Bibliothèque
Résout un nom de paquet/produit en un identifiant de bibliothèque compatible Context7 et retourne les bibliothèques correspondantes.
ctx7 library react "Comment nettoyer useEffect avec des opérations asynchrones"
ctx7 library nextjs "Comment configurer le routeur d'application avec middleware"
ctx7 library prisma "Comment définir des relations un-à-plusieurs avec suppression en cascade"
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 les ambiguïtés lorsque plusieurs bibliothèques partagent un nom similaire. N'incluez aucune information sensible ou confidentielle telle que des clés API, mots de passe, identifiants, données personnelles ou code propriétaire dans votre requête.
Champs des résultats
Chaque résultat inclut :
- Identifiant de bibliothèque — Identifiant compatible Context7 (format :
/org/projet) - Nom — Nom de la bibliothèque ou du paquet
- Description — Résumé court
- Extraits de code — Nombre d'exemples de code disponibles
- Réputation de la source — Indicateur d'autorité (Élevée, Moyenne, Faible ou Inconnue)
- Score de référence — Indicateur de qualité (100 est le score le plus élevé)
- Versions — Liste des versions disponibles. Utilisez l'une de ces versions si l'utilisateur fournit une version dans sa requête. Le format est
/org/projet/version.
Processus de sélection
- Analysez la requête pour comprendre quelle bibliothèque/paquet l'utilisateur recherche
- Sélectionnez la correspondance la plus pertinente en fonction de :
- Similarité du nom avec la requête (les correspondances exactes sont prioritaires)
- Pertinence de la description par rapport à l'intention de la requête
- Couverture de la documentation (privilégiez les bibliothèques avec un nombre d'extraits de code plus élevé)
- Réputation de la source (considérez les bibliothèques avec une réputation Élevée ou Moyenne comme plus autoritaires)
- Score de référence (plus élevé est meilleur, 100 est le maximum)
- Si plusieurs bonnes correspondances existent, mentionnez-le mais continuez avec la plus pertinente
- Si aucune bonne correspondance n'existe, indiquez-le clairement et suggérez des améliorations de la requête
- Pour les requêtes ambiguës, demandez des clarifications avant de procéder avec une correspondance par estimation
Identifiants spécifiques à une version
Si l'utilisateur mentionne une version spécifique, utilisez un identifiant de bibliothèque spécifique à la version :
# Général (dernière version indexée)
ctx7 docs /vercel/next.js "Comment configurer le routeur d'application"
# Spécifique à une version
ctx7 docs /vercel/next.js/v14.3.0-canary.87 "Comment configurer le routeur d'application"
Les versions disponibles sont listées dans la sortie de 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 et les exemples de code à jour pour la bibliothèque résolue.
ctx7 docs /facebook/react "Comment nettoyer useEffect avec des opérations asynchrones"
ctx7 docs /vercel/next.js "Comment ajouter un middleware d'authentification au routeur d'application"
ctx7 docs /prisma/prisma "Comment définir des relations un-à-plusieurs avec suppression en cascade"
Rédiger de bonnes requêtes
La requête affecte directement la qualité des résultats. Soyez précis et incluez des détails pertinents. N'incluez aucune information sensible ou confidentielle telle que des clés API, mots de passe, identifiants, données personnelles ou code propriétaire dans votre requête.
| Qualité | Exemple |
|---|---|
| Bonne | "Comment configurer l'authentification JWT dans Express.js" |
| Bonne | "Fonction de nettoyage de React useEffect avec opérations asynchrones" |
| Mauvaise | "auth" |
| Mauvaise | "hooks" |
Utilisez la question complète de l'utilisateur comme requête lorsque c'est possible ; des requêtes vagues d'un seul mot renvoient des résultats génériques.
La sortie contient deux types de contenu : les extraits de code (titrés, avec des blocs balisés par langage) et les extraits d'information (explications en prose avec contexte de fil d'Ariane).
Authentification
Fonctionne sans authentification. Pour des limites de débit plus élevées :
# Option A : variable d'environnement
export CONTEXT7_API_KEY=votre_clé
# Option B : connexion OAuth
ctx7 login
Gestion des Erreurs
Si une commande échoue avec une erreur de quota (« Quota mensuel atteint » ou « quota dépassé ») :
- Informez l'utilisateur que son quota Context7 est épuisé
- Suggérez-lui de s'authentifier pour des limites plus élevées :
ctx7 login - S'il ne peut pas ou choisit de ne pas s'authentifier, répondez à partir des connaissances d'entraînement et notez clairement qu'elles peuvent être obsolètes
Ne retombez pas silencieusement sur les données d'entraînement — dites toujours à l'utilisateur pourquoi Context7 n'a pas été utilisé.
Erreurs Courantes
- Les identifiants de bibliothèque nécessitent un préfixe
/—/facebook/reactpasfacebook/react - Exécutez toujours
ctx7 libraryd'abord —ctx7 docs react "hooks"échouera sans un identifiant valide - Utilisez des requêtes descriptives, pas des mots isolés —
"Fonction de nettoyage React useEffect"pas"hooks" - N'incluez pas d'informations sensibles (clés API, mots de passe, identifiants) dans les requêtes