Recherche avec GitHub Copilot CLI

Utilisez la /research commande barre oblique pour examiner un sujet complexe et produire un rapport cité à partir de votre codebase, référentiels sur GitHubet sources web.

Qui peut utiliser cette fonctionnalité ?

GitHub Copilot CLI est disponible dans tous les forfaits Copilot. Si vous recevez Copilot d’une organisation, la Copilot CLI stratégie doit être activée dans les paramètres de l’organisation.

Dans cet article

À propos de la recherche sur Copilot CLI

La /research commande slash appelle un agent de recherche spécialisé. Il examine un sujet et produit un rapport Markdown cité. L’agent peut collecter des informations à partir de votre base de code locale, de dépôts publics et de dépôts privés accessibles au sein de votre organisation, et du web.

La recherche est optimisée pour les questions complexes qui nécessitent une enquête approfondie. Pour obtenir une vue d’ensemble de la recherche dans les différentes interfaces Copilot, consultez Recherche à l’aide d’agents.

Mener une investigation de recherche

  1. Dans une session interactive Copilot CLI , entrez :

    Copilot prompt
    /research TOPIC

    Remplacez TOPIC par une description en langage naturel de ce que vous souhaitez examiner.

  2. Si vous y êtes invité, passez en revue et approuvez les autorisations dont l’agent a besoin. Par exemple, l’agent peut demander l’autorisation de créer un répertoire pour stocker des données lors de la compilation du travail de recherche.

  3. Attendez que l’étude se termine. Copilot affiche un résumé des principaux résultats. Il fournit également un lien vers le rapport Markdown complet.

  4. Passez en revue le rapport, y compris ses sources et ses hypothèses documentées.

Rédaction d’une invite de recherche efficace

Indiquez votre question, son étendue et le type de réponse souhaité. Le cas échéant, incluez les référentiels, les composants, les technologies, les contraintes ou la période à examiner.

L’agent de recherche adapte son rapport à la question :

  • Les questions de processus produisent généralement des instructions pas à pas.
  • Les questions conceptuelles produisent généralement des explications narratives et des arbitrages.
  • Les présentations techniques approfondies peuvent inclure des diagrammes d’architecture et des exemples de code.

Voici quelques exemples de requêtes de recherche et des explications de pourquoi elles fonctionnent bien.

Architecture de la base de code

Copilot prompt
/research What is the architecture of this codebase?

Pourquoi cela fonctionne bien : l’agent de recherche a accès aux outils ****, grep, et glob dans le périmètre de votre répertoire de travail actuel. Il peut explorer l’arborescence complète du projet, lire les fichiers clés et synthétiser une vue d’ensemble architecturale , quelque chose qu’une réponse de conversation normale peut faire uniquement superficiellement. L’agent produit généralement des diagrammes d’architecture, des répartitions de composants et des descriptions de flux de données.

Fonctionnement d’une technologie spécifique

Copilot prompt
/research How does React implement concurrent rendering?

Pourquoi cela fonctionne bien : l’agent utilise des outils spécialisés pour extraire des informations à partir d’Internet et examiner le code source React réel sur GitHub. Il est demandé de hiérarchiser le code par rapport à la documentation et de fournir des chemins d’accès aux fichiers avec des numéros de ligne.

Présentation des modèles d’implémentation internes

Copilot prompt
/research How are feature flags implemented at our organization?

Pourquoi cela fonctionne bien : l’agent est explicitement invité à « hiérarchiser toujours les implémentations internes/privées sur les alternatives publiques/open source » et à rechercher d’abord les référentiels de l’organisation à l’aide org:ORGNAME de requêtes. Il sait rechercher des modèles d’affectation de noms internes comme -hub, -service``-client.

Comparaison des technologies ou approches

Copilot prompt
/research What's the difference between JWT and session-based authentication?

Pourquoi cela fonctionne bien : l’agent adapte sa réponse à « Questions conceptuelles/explicatifs » avec des explications narratives, des compromis et des décisions de conception. Il utilise généralement des tables pour les comparaisons de trois éléments ou plus.

Questions de processus/procédures

Copilot prompt
/research How do I add an endpoint to the API?

Pourquoi cela fonctionne bien : l’agent est formé pour détecter le type de requête et fournir des instructions pas à pas avec des liens vers des documents, des contacts et des systèmes pertinents pour les questions de type processus/procédure.

Plongée approfondie dans un composant de base de code spécifique

Copilot prompt
/research How is the session management system implemented in this repo?

Pourquoi cela fonctionne bien : la combinaison d’outils locaux (grep, glob, view) avec les instructions de l’agent pour « tracer les importations, les appels et les références de type » et « suivre les dépendances » signifie qu’il va parcourir l’implémentation réelle, pas seulement donner une réponse de haut niveau.

Affichage et partage d’un rapport de recherche

Une fois la recherche terminée, utilisez le lien affiché pour ouvrir le rapport complet dans votre éditeur Markdown par défaut. Vous pouvez également appuyer sur Ctrl+Y pour ouvrir le rapport de recherche le plus récent de la session active.

Remarque

L’éditeur utilisé par Ctrl+Y est déterminé par les COPILOT_EDITOR, VISUAL ou EDITOR variables d’environnement, dans cet ordre. Sur Linux et macOS, si aucune de ces variables n’est définie, Copilot CLI utilise vi.

Pour créer un GitHub gist contenant un rapport de recherche, entrez :

Copilot prompt
/share gist research

Pour enregistrer un rapport dans un fichier, entrez :

Copilot prompt
/share file research [PATH]

Si vous omettez [PATH], le rapport est enregistré dans le répertoire de travail actuel avec un nom de fichier basé sur le sujet de recherche.

Utilisez les touches de direction et Entrée pour sélectionner un rapport créé pendant la session active. Copilot CLI affiche ensuite l’URL du gist ou le chemin d’accès au fichier enregistré.

Considérations

  • Les rapports Research appartiennent à une session : le sélecteur de rapports et le raccourci Ctrl+Y affichent uniquement les rapports de la session active. Vous pouvez toujours accéder aux rapports des sessions précédentes dans ~/.copilot/session-state/SESSION-ID/research/.
  • La recherche utilise un modèle dédié : l’agent de recherche utilise son modèle configuré, quel que soit le modèle sélectionné pour votre session principale. Vous ne pouvez pas modifier le modèle de recherche avec /model.
  • La recherche prend plus de temps que la conversation normale : l’agent recherche plusieurs sources et produit un rapport détaillé. Utilisez un prompt normal pour des questions rapides et limitées.
  • La recherche n’apporte pas de modifications de code : le flux de travail de recherche produit des résultats plutôt que de modifier votre projet. Démarrez ou reprenez une tâche d’agent normale lorsque vous êtes prêt à implémenter des modifications.