Como usar a CLI do GitHub Copilot

A CLI (interface de linha de comando) do GitHub Copilot permite que você use o Copilot diretamente no terminal. Para saber mais, confira Sobre a CLI do GitHub Copilot.

Observação

CLI do GitHub Copilot está em visualização pública com proteção de dados e está sujeito a alterações.

Pré-requisito

Instalar a CLI do Copilot. Confira Como instalar a CLI do GitHub Copilot.

Como usar a CLI do Copilot

No terminal, navegue até uma pasta que contém o código com o qual você deseja trabalhar.
Insira copilot para iniciar a CLI do Copilot.

O Copilot solicitará que você confirme se confia nos arquivos desta pasta.

Importante

Durante esta sessão da CLI do GitHub Copilot, o Copilot pode tentar ler, modificar e executar arquivos nesta pasta e nas subpastas. Você só deve continuar se confiar nos arquivos neste local. Para obter mais informações sobre diretórios confiáveis, consulte Sobre a CLI do GitHub Copilot.
Escolha uma das opções:
```
       **1. Sim, prossiga**:
```
o Copilot pode trabalhar com os arquivos neste local apenas nesta sessão.
```
       **2. Sim, e lembre-se desta pasta nas sessões futuras**:
```
Você confia nos arquivos desta pasta para esta sessão e futuras sessões. Você não será solicitado novamente quando iniciar a CLI do Copilot nesta pasta. Escolha esta opção somente se tiver certeza de que sempre será seguro para o Copilot trabalhar com arquivos neste local.
```
       **3. Não, sair (Esc)**:
```
termine sua sessão da CLI do Copilot.
Se você não estiver conectado no momento ao GitHub, será solicitado que você use o comando de barra /login. Insira esse comando e siga as instruções na tela para autenticar.
Insira um prompt na CLI.

Ele pode ser uma pergunta de chat simples ou uma solicitação do Copilot para executar uma tarefa específica, como corrigir um bug, adicionar um recurso a um aplicativo existente ou criar um aplicativo.

Para obter alguns exemplos de prompts, consulte Sobre a CLI do GitHub Copilot.
Quando o Copilot deseja usar uma ferramenta que pode modificar ou executar arquivos — por exemplo, touch, chmod, node ou sed— ele solicitará que você aprove o uso da ferramenta.

Escolha uma das opções:
```
       **1. Sim**:
```
permitir que o Copilot use esta ferramenta. Na próxima vez que o Copilot quiser usar essa ferramenta, ele solicitará que você aprove novamente.
```
       **2. Sim, e aprove a FERRAMENTA para o restante da sessão em execução**:
```
Permita que o Copilot use essa ferramenta, com qualquer opção, sem perguntar novamente, pelo restante da sessão em execução no momento. Todas as solicitações de permissão paralela pendentes do mesmo tipo serão aprovadas automaticamente. Você precisará aprovar o comando novamente em sessões futuras.

Escolher essa opção é útil para muitas ferramentas, como chmod, por exemplo, evita que você precise aprovar comandos semelhantes repetidamente na mesma sessão. No entanto, esteja ciente das implicações de segurança dessa opção. Por exemplo, escolher essa opção para o comando rm permitiria Copilot excluir qualquer arquivo no diretório atual ou seus subdiretórios sem solicitar sua aprovação.
```
       **3. Não, e informe ao Copilot o que fazer de forma diferente (Esc)**:
```
O Copilot não executará o comando. Em vez disso, ele encerrará a operação atual e aguardará seu próximo prompt. Você pode informar ao Copilot para continuar a tarefa, mas usando uma abordagem diferente.

Por exemplo, se você pedir ao Copilot para criar um script do Bash, mas não quiser usar o script que o Copilot sugerir, poderá interromper a operação atual e inserir um novo prompt, como: Continue the previous task but include usage instructions in the script.

Ao rejeitar uma solicitação de permissão de ferramenta, você também pode fornecer ao Copilot feedback imediato sobre a rejeição para que ele possa adaptar sua abordagem sem parar completamente.

Dicas

Otimize sua experiência com a CLI do Copilot com as dicas a seguir.

Parar uma operação atualmente em execução

Se você inserir um prompt e decidir que deseja impedir que o Copilot conclua a tarefa enquanto ele ainda estiver "Pensando", pressione Esc.

Usar o modo de planejamento

O modo de plano permite que você colabore com Copilot em um plano de implementação antes de qualquer código ser escrito. Pressione Shift+Tab para entrar e sair do modo de plano.

Conduza a conversa enquanto Copilot está pensando

Você pode interagir com Copilot enquanto ele pensa. Envie mensagens de acompanhamento para redirecionar a conversa ou enfileirar instruções adicionais para que Copilot processe após concluir sua resposta atual.

Incluir um arquivo específico no prompt

Para adicionar um arquivo específico ao prompt, use @ seguido pelo caminho relativo para o arquivo. Por exemplo: Explain @config/ci/ci-required-checks.yml ou Fix the bug in @src/app.js. Isso adiciona o conteúdo do arquivo ao prompt como contexto para o Copilot.

Quando você começa a digitar um caminho de arquivo, os caminhos correspondentes são exibidos abaixo da caixa de prompt. Use as teclas de direção para selecionar um caminho e pressione Tab para concluir o caminho no prompt.

Trabalhar com arquivos em um local diferente

Para realizar uma tarefa, o Copilot talvez precise trabalhar com arquivos que estão fora do diretório de trabalho atual. Se um prompt que você inseriu em uma sessão interativa exigir que o Copilot modifique um arquivo fora do local atual, ele solicitará que você aprove o acesso ao diretório do arquivo.

Você também pode adicionar um diretório confiável manualmente a qualquer momento usando o comando de barra:

/add-dir /path/to/directory

Se todos os arquivos com os quais você deseja trabalhar estiverem em um local diferente, você pode alternar o diretório de trabalho atual sem iniciar uma nova sessão CLI do Copilot, usando os comandos /cwd ou /cd slash:

/cwd /path/to/directory

Executar comandos de shell

Você pode preparar sua entrada ! para executar comandos de shell diretamente, sem fazer uma chamada para o modelo.

!git clone https://github.com/github/copilot-cli

Delegar tarefas a Agente de codificação do Copilot

O comando delegate permite que você envie sua sessão atual para Agente de codificação do Copilot em GitHub. Isso permite que você delegue o trabalho, preservando todo o contexto Copilot necessário para concluir sua tarefa.

Você pode delegar uma tarefa usando o comando de barra, seguido por um prompt.

/delegate complete the API integration tests and fix any failing edge cases

Como alternativa, prefixe um prompt com & para delegá-lo:

& complete the API integration tests and fix any failing edge cases

Copilot solicitará que você confirme quaisquer alterações não preparadas como um ponto de verificação em uma nova ramificação que ele criar. Agente de codificação do Copilot abrirá uma solicitação de pull em rascunho, fará alterações em segundo plano e solicitará sua revisão.

Copilot fornecerá um link para a solicitação pull e para a sessão do agente em GitHub assim que a sessão começar.

Retomar uma sessão interativa

Você pode usar a --resume opção de linha de comando ou o /resume comando de barra para alternar e retomar sessões interativas locais e remotas, permitindo que você retome exatamente de onde parou com o contexto existente. Você pode iniciar uma sessão Agente de codificação do Copilot em GitHube, em seguida, usar CLI do GitHub Copilot para trazer essa sessão para o seu ambiente local.

Você pode retomar rapidamente a sessão local fechada mais recentemente usando a opção --continue de linha de comando.

Usar instruções personalizadas

Você pode aprimorar o desempenho do Copilot, adicionando instruções personalizadas ao repositório no qual você está trabalhando. Instruções personalizadas são descrições em idioma natural salvas em arquivos Markdown no repositório. Elas são incluídas automaticamente nos prompts inseridos durante o trabalho nesse repositório. Isso ajuda o Copilot a entender melhor o contexto do seu projeto e como responder aos prompts.

A CLI do Copilot é compatível com:

Instruções em todo o repositório no arquivo .github/copilot-instructions.md.
Arquivos de instruções específicas de caminho: .github/instructions/**/*.instructions.md.
Arquivos de agente, como AGENTS.md.

Para saber mais, confira Using GitHub Copilot CLI.

Usar agentes personalizados

Um agente personalizado é uma versão especializada do Copilot. Agentes personalizados ajuda Copilot lidar com fluxos de trabalho exclusivos, convenções de codificação específicas e casos de uso especializado.

CLI do Copilot inclui um grupo padrão de agentes personalizados para tarefas comuns:

Agente	Description
Explorar	Executa uma análise rápida da base de código, permitindo que você faça perguntas sobre seu código sem adicionar ao contexto principal.
Tarefa	Executa comandos como testes e compilações, fornecendo breves resumos em caso de sucesso e saída completa em caso de falha.
Uso geral	Lida com tarefas complexas e de várias etapas que exigem o conjunto de ferramentas completo e o raciocínio de alta qualidade, em execução em um contexto separado para manter sua conversa principal claramente focada.
Revisão de código	Revê as mudanças com o foco em destacar apenas problemas genuínos, minimizando o ruído.

O modelo de IA que está sendo usado pela CLI pode optar por delegar uma tarefa a um processo de um subagente subsidiário, que opera usando um agente personalizado especializado, se ele julgar que isto resultaria na conclusão do trabalho de forma mais eficaz. O modelo pode igualmente escolher lidar com o trabalho diretamente no agente principal.

Você pode definir seu próprio agentes personalizados usando arquivos Markdown, chamado perfis de agente, que especificam qual experiência o agente deve ter, quais ferramentas ele pode usar e quaisquer instruções específicas sobre como ele deve responder.

Você pode definir agentes personalizados no nível de usuário, repositório ou organização/empresa:

Tipo	Localização	Scope
Nível de usuário agente personalizado	diretório local `~/.copilot/agents`	Todos os projetos
Nível de repositório agente personalizado

          `.github/agents` diretório em seus repositórios locais e remotos | Projeto atual |

| Nível organizacional e empresarial agente personalizado | /agents diretório no repositório .github-private em uma organização ou corporação | Todos os projetos sob sua organização e conta empresarial |

No caso de conflitos de nomenclatura, um agente no nível do sistema substitui um agente no nível do repositório e o agente no nível do repositório substituiria um agente no nível da organização.

Agentes personalizados podem ser usados de três maneiras:

Usando o comando barra na interface interativa da CLI para selecionar na lista de dados disponíveis agentes personalizados:
```
/agent
```
Invocando agente personalizado diretamente em uma solicitação:
```
Use the refactoring agent to refactor this code block
```
Copilot inferirá automaticamente o agente que você deseja usar.
Especificando o agente personalizado que você deseja usar com a opção de linha de comando. Por exemplo:
```
copilot --agent=refactor-agent --prompt "Refactor this code block"
```

Para saber mais, confira Criando agentes personalizados para Agente de codificação do Copilot.

Utilizar habilidades

Você pode criar habilidades para aprimorar a capacidade do Copilot de executar tarefas especializadas com instruções, scripts e recursos.

Para saber mais, confira Criando habilidades de agente para CLI do GitHub Copilot.

Adicionar um servidor MCP

A CLI do Copilot vem com o servidor de MCP do GitHub já configurado. Esse servidor de MCP permite que você interaja com recursos no GitHub.com, por exemplo, permitindo mesclar pull requests na CLI.

Para estender a funcionalidade disponível para você na CLI do Copilot, você pode adicionar mais servidores de MCP:

Use o seguinte comando de barra:
```
/mcp add
```
Preencha os detalhes do servidor de MCP que você deseja adicionar, usando a tecla Tab para mover-se entre os campos.
Pressione Ctrl+S para salvar os detalhes.

Os detalhes dos servidores de MCP configurados são armazenados no arquivo mcp-config.json, que está localizado, por padrão, no diretório ~/.copilot. Esse local pode ser alterado definindo a variável de ambiente XDG_CONFIG_HOME. Para obter informações sobre a estrutura JSON de uma definição de servidor, consulte Como estender o agente de codificação do GitHub Copilot com o MCP (Model Context Protocol).

Gerenciamento de contexto

CLI do Copilot fornece vários comandos de barra para ajudá-lo a monitorar e gerenciar a sua janela de contexto:

```
        `/usage`: permite exibir suas estatísticas de sessão, incluindo:
```
- A quantidade de solicitações premium usadas na sessão atual
- A duração da sessão
- O total de linhas de código editadas
- Um detalhamento do uso de token por modelo

        `/context`: fornece uma visão geral visual do uso atual de tokens.

        `/compact`: compacta manualmente o histórico de conversas para liberar espaço de contexto

CLI do GitHub Copilot compacta automaticamente seu histórico em segundo plano quando sua conversa se aproxima de 95% do limite de tokens, sem interromper o fluxo de trabalho.

Revisar alterações de código

Você pode usar o comando de barra /review para que Copilot analise as alterações de código sem sair da CLI. Isso permite que você receba comentários rápidos sobre suas alterações antes de se comprometer.

Habilitar todas as permissões

Para situações em que você confia em Copilot para ser executado livremente, você pode usar --allow-all ou --yolo sinalizadores para habilitar todas as permissões de uma só vez.

Alternar a visibilidade do raciocínio

Pressione Ctrl+T para mostrar ou ocultar o processo de raciocínio do modelo enquanto ele gera uma resposta. Essa configuração persiste entre sessões, permitindo que você avalie como Copilot funciona em problemas complexos.

Saiba mais

Para obter uma lista completa das opções de linha de comando e comandos de barra que você pode usar com a CLI do Copilot, siga um dos seguintes procedimentos:

Insira ? na caixa de prompt em uma sessão interativa.
Insira copilot help no terminal.

Para obter informações adicionais, use um dos seguintes comandos em seu terminal:

```
        **Definições da configuração**:
```
copilot help config

Você pode ajustar as definições de configuração editando o arquivo config.json, que está localizado, por padrão, no diretório ~/.copilot. Esse local pode ser alterado definindo a variável de ambiente XDG_CONFIG_HOME.

        **Variáveis de ambiente** que afetam CLI do Copilot:

copilot help environment

        **Níveis de log disponíveis**:

copilot help logging

        **Permissões** para permitir ou negar o uso da ferramenta:

copilot help permissions

Comentários

Se você tiver algum comentário sobre a CLI do GitHub Copilot, informe-nos usando o comando de barra /feedback em uma sessão interativa e escolhendo uma das opções. Você pode preencher uma pesquisa de comentários privada, enviar um relatório de bugs ou sugerir um novo recurso.

Leitura adicional

        [AUTOTITLE](/copilot/how-tos/copilot-cli/cli-best-practices)

        [AUTOTITLE](/copilot/reference/cli-command-reference)

        [AUTOTITLE](/copilot/reference/acp-server)

Quem pode usar esse recurso?

Neste artigo