Investigación con GitHub Copilot CLI

Usa el /research comando de barra diagonal para investigar un tema complejo y generar un informe citado a partir de tu base de código, repositorios en GitHub y fuentes web.

¿Quién puede utilizar esta característica?

GitHub Copilot CLI está disponible con todos los Copilot planes. Si una organización le envía Copilot, la política Copilot CLI debe estar habilitada en la configuración de la organización.

En este artículo

Acerca de la investigación en Copilot CLI

El /research comando de barra diagonal invoca a un agente de investigación especializado. Investiga un tema y genera un informe de Markdown citado. El agente puede recopilar información de su código base local, repositorios públicos y privados accesibles en toda la organización y en la web.

La investigación está optimizada para preguntas complejas que requieren una investigación detallada. Para obtener información general sobre la investigación sobre distintas superficies Copilot, consulte Investigar con agentes.

Realización de una investigación

  1. En una sesión interactiva Copilot CLI , escriba:

    Copilot prompt
    /research TOPIC

    Reemplace TOPIC por una descripción en lenguaje natural de lo que desea investigar.

  2. Si se le solicita, revise y apruebe los permisos que necesita el agente. Por ejemplo, el agente puede solicitar permiso para crear un directorio para almacenar datos al compilar la investigación en curso.

  3. Espere a que se complete la investigación. Copilot muestra un resumen de los resultados clave. También proporciona un vínculo al informe completo de Markdown.

  4. Revise el informe, incluidas sus fuentes y suposiciones documentadas.

Escribir un prompt de investigación eficaz

Indique su pregunta, su ámbito y el tipo de respuesta que desee. Si procede, incluya los repositorios, componentes, tecnologías, restricciones o período de tiempo que se van a investigar.

El agente de investigación adapta su informe a la pregunta:

  • Las preguntas de proceso suelen generar instrucciones paso a paso.
  • Las preguntas conceptuales suelen generar explicaciones narrativas y contrapartidas.
  • Los análisis detallados técnicos pueden incluir diagramas de arquitectura y ejemplos de código.

A continuación se muestran algunas indicaciones de investigación de ejemplo y explicaciones de por qué funcionan bien.

Arquitectura de código base

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

Por qué funciona bien: el agente de investigación tiene acceso a greplas herramientas , globy view cuyo ámbito es el directorio de trabajo actual. Puede explorar el árbol completo del proyecto, leer archivos clave y sintetizar una visión general de la arquitectura, algo que una respuesta de chat normal podría hacer solo superficialmente. Normalmente, el agente generará diagramas de arquitectura, desgloses de componentes y descripciones de flujo de datos.

Funcionamiento de una tecnología específica

Copilot prompt
/research How does React implement concurrent rendering?

Por qué funciona bien: el agente usa herramientas especializadas para extraer información de Internet y para ver el código fuente real de React en GitHub. Se instruye que se dé prioridad al código sobre la documentación y se proporcionen rutas de archivo con números de línea.

Descripción de los patrones de implementación internos

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

Por qué funciona bien: el agente se indica explícitamente que "priorice siempre las implementaciones internas o privadas a través de alternativas públicas o de código abierto" y busque primero los repositorios de la organización mediante org:ORGNAME consultas. Sabe buscar patrones de nomenclatura internos como -hub, -service, -client.

Comparación de tecnologías o enfoques

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

Por qué funciona bien: el agente adapta su respuesta a "Preguntas conceptuales/explicativas" con explicaciones narrativas, inconvenientes y decisiones de diseño. Normalmente, usará tablas para comparaciones de tres o más elementos.

Preguntas de procedimientos y procesos

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

Por qué funciona bien: el agente está entrenado para detectar el tipo de consulta y proporcionar una guía paso a paso con enlaces a documentos, contactos y sistemas relevantes para preguntas de proceso o cómo hacer.

Profundización en un componente de código base específico

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

Por qué funciona bien: combinar herramientas locales (grep, glob, view) con las instrucciones del agente para "realizar un seguimiento de las importaciones, llamadas y referencias de tipo" y "seguir las dependencias" significa que recorrerá la implementación real, no solo dar una respuesta de alto nivel.

Visualización y uso compartido de un informe de investigación

Cuando finalice la investigación, use el vínculo mostrado para abrir el informe completo en el editor predeterminado de Markdown. Como alternativa, presione Ctrl+Y para abrir el informe de investigación más reciente de la sesión actual.

Nota:

El editor usado por Ctrl+Y viene determinado por las variables de entorno COPILOT_EDITOR, VISUAL o EDITOR, en ese orden. En Linux y macOS, si no se establece ninguna de estas variables, Copilot CLI usa vi.

Para crear un GitHub gist que contenga un informe de investigación, escriba:

Copilot prompt
/share gist research

Para guardar un informe en un archivo, escriba:

Copilot prompt
/share file research [PATH]

Si omite [PATH], el informe se guarda en el directorio de trabajo actual con un nombre de archivo basado en el tema de investigación.

Utilice las teclas de dirección y Intro para seleccionar un informe creado durante la sesión actual. Copilot CLI a continuación, muestra la dirección URL del gist o la ruta de acceso al archivo guardado.

Considerations

  • Los informes de investigación pertenecen a una sesión: el selector de informes y el acceso directo Ctrl+Y solo muestran informes de la sesión actual. Todavía puede acceder a informes de sesiones anteriores en ~/.copilot/session-state/SESSION-ID/research/.
  • La investigación usa un modelo dedicado: el agente de investigación usa su modelo configurado independientemente del modelo seleccionado para la sesión principal. No se puede cambiar el modelo de investigación con /model.
  • La investigación tarda más de lo normal: el agente busca en varias fuentes y genera un informe detallado. Usa un prompt normal para preguntas rápidas y limitadas.
  • La investigación no realiza cambios en el código: el flujo de trabajo de investigación genera resultados en lugar de modificar el proyecto. Inicie u reanude una tarea de agente normal cuando esté listo para implementar cambios.