Pesquisando com GitHub Copilot CLI

Use o /research comando barra para investigar um tópico complexo e produzir um relatório citado de sua base de código, repositórios no GitHub e fontes da Web.

Quem pode usar esse recurso?

GitHub Copilot CLI está disponível com todos os Copilot planos. Se você receber Copilot de uma organização, a Copilot CLI política deverá ser habilitada nas configurações da organização.

Neste artigo

Sobre a pesquisa em Copilot CLI

O /research comando slash invoca um agente de pesquisa especializado. Ele investiga um tópico e produz um relatório em Markdown com citações. O agente pode coletar informações de sua base de código local, repositórios públicos e repositórios privados acessíveis em sua organização, e da Web.

A pesquisa é otimizada para perguntas complexas que exigem uma investigação aprofundada. Para obter uma visão geral da pesquisa em diferentes Copilot superfícies, consulte Pesquisando com agentes.

Executando uma pesquisa investigativa

  1. Em uma sessão interativa Copilot CLI , insira:

    Copilot prompt
    /research TOPIC

    Substitua TOPIC por uma descrição de linguagem natural do que você deseja investigar.

  2. Se solicitado, examine e aprove as permissões de que o agente precisa. Por exemplo, o agente pode solicitar permissão para criar um diretório para armazenar dados durante a compilação da pesquisa.

  3. Aguarde a conclusão da pesquisa. Copilot exibe um resumo das principais descobertas. Ele também fornece um link para o relatório markdown completo.

  4. Examine o relatório, incluindo suas fontes e suposições documentadas.

Escrevendo um prompt de pesquisa eficaz

Declare sua pergunta, seu escopo e o tipo de resposta desejada. Se relevante, inclua os repositórios, componentes, tecnologias, restrições ou período de tempo a serem investigados.

O agente de pesquisa adapta seu relatório à pergunta:

  • As perguntas de processo normalmente produzem diretrizes passo a passo.
  • Perguntas conceituais normalmente produzem explicações narrativas e trade-offs.
  • Os aprofundamentos técnicos podem incluir diagramas de arquitetura e exemplos de código.

Abaixo estão alguns exemplos de solicitações de pesquisa e explicações sobre por que funcionam bem.

Arquitetura de base de código

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

Por que funciona bem: o agente de pesquisa tem acesso a grep, globe view ferramentas com escopo para seu diretório de trabalho atual. Ele pode explorar a árvore de projeto completa, ler arquivos de chave e sintetizar uma visão geral da arquitetura— algo que uma resposta de chat normal pode fazer apenas superficialmente. O agente normalmente produzirá diagramas de arquitetura, divisões de componentes e descrições de fluxo de dados.

Como uma tecnologia específica funciona

Copilot prompt
/research How does React implement concurrent rendering?

Por que funciona bem: o agente usa ferramentas especializadas para extrair informações da Internet e examinar o código-fonte real do React.GitHub Ele é instruído a priorizar o código sobre a documentação e fornecer caminhos de arquivo com números de linha.

Noções básicas sobre padrões de implementação interna

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

Por que funciona bem: o agente é explicitamente instruído a "sempre priorizar implementações internas/privadas em relação a alternativas públicas/de software livre" e pesquisar os repositórios da organização primeiro usando org:ORGNAME consultas. Ele sabe procurar padrões de nomenclatura internos como-hub, , -service. -client

Comparando tecnologias ou abordagens

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

Por que funciona bem: o agente adapta sua resposta a "Perguntas Conceituais/Explicativas" com explicações narrativas, compensações e decisões de design. Normalmente, ele usará tabelas para comparações de três ou mais itens.

Perguntas de processo/instruções

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

Por que funciona bem: o agente é treinado para detectar o tipo de consulta e fornecer diretrizes passo a passo com links para documentos, contatos e sistemas relevantes para perguntas de tipo de processo/instruções.

Aprofundamento em um componente específico da base de código

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

Por que funciona bem: combinar ferramentas locais (grep, glob, view) com as instruções do agente para "rastrear importações, chamadas e referências de tipo" e "seguir dependências" significa que ele irá analisar a implementação real, não apenas oferecer uma resposta superficial.

Exibindo e compartilhando um relatório de pesquisa

Quando a pesquisa for concluída, use o link exibido para abrir o relatório completo em seu editor markdown padrão. Como alternativa, pressione Ctrl+Y para abrir o relatório de pesquisa mais recente da sessão atual.

Observação

O editor usado por Ctrl+Y é determinado pelas variáveis de ambiente COPILOT_EDITOR, EDITOR ou VISUAL, nessa ordem. No Linux e no macOS, se nenhuma dessas variáveis estiver definida, Copilot CLI usará vi.

Para criar uma GitHub gist que contenha um relatório de pesquisa, insira:

Copilot prompt
/share gist research

Para salvar um relatório em um arquivo, insira:

Copilot prompt
/share file research [PATH]

Se você omitir [PATH], o relatório será salvo no diretório de trabalho atual com um nome de arquivo baseado no tópico de pesquisa.

Use as teclas de direção e Enter para selecionar um relatório criado durante a sessão atual. Copilot CLI em seguida, exibe a URL da gist ou o caminho para o arquivo salvo.

Considerations

  • Os relatórios de pesquisa pertencem a uma sessão: o seletor de relatório e o atalho Ctrl+Y mostram apenas relatórios da sessão atual. Você ainda pode acessar relatórios de sessões anteriores em ~/.copilot/session-state/SESSION-ID/research/.
  • A pesquisa usa um modelo dedicado: o agente de pesquisa usa seu modelo configurado, independentemente do modelo selecionado para sua sessão principal. Você não pode alterar o modelo de pesquisa com /model.
  • A pesquisa leva mais tempo do que o chat normal: o agente pesquisa várias fontes e produz um relatório detalhado. Use um prompt normal para perguntas rápidas e com escopo estreito.
  • A pesquisa não faz alterações de código: o fluxo de trabalho de pesquisa produz descobertas em vez de modificar seu projeto. Inicie ou retome uma tarefa normal do agente quando estiver pronto para implementar as alterações.