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

A CLI do GitHub Copilot está em visualização pública e sujeita 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. Você precisará aprovar o comando novamente em sessões futuras.

Escolher essa opção é útil para muitas ferramentas, como chmod, pois evita que você precise aprovar comandos semelhantes repetidamente na mesma sessão. No entanto, você deve estar ciente das implicações de segurança dessa opção. Escolher essa opção para o comando rm, por exemplo, permitiria que o Copilot excluísse qualquer arquivo na pasta atual ou nas respectivas subpastas 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.

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.

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ê poderá trocar de diretório de trabalho atual sem iniciar uma nova sessão da CLI do Copilot usando o comando de barra:

/cwd /path/to/directory

Retomar uma sessão interativa

Você pode retornar a uma sessão interativa anterior e continuar sua conversa com o Copilot, usando a opção de linha de comando --resume e escolhendo a sessão que você deseja retomar na lista exibida.

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/copilot-instructions/**/*.instructions.md.
Arquivos de agente, como AGENTS.md.

Para saber mais, confira Como adicionar instruções personalizadas de repositório no GitHub Copilot.

Adicionar um servidor de 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 ~/.config. 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).

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 de 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 ~/.config. Esse local pode ser alterado definindo a variável de ambiente XDG_CONFIG_HOME.
Variáveis de ambiente que afetam a 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.

Quem pode usar esse recurso?

Neste artigo