Usar o GitHub Copilot na CLI

Você pode usar gh, a interface de linha de comando do GitHub, para trabalhar com o GitHub Copilot in the CLI.

Neste artigo

Sobre o uso do GitHub Copilot in the CLI

A GitHub CLI é uma ferramenta de código aberto para uso do GitHub na linha de comando do computador. Quando você está trabalhando na linha de comando, você pode usar GitHub CLI para economizar tempo e evitar mudar o contexto. Para saber mais, confira "Sobre o a CLI do GitHub".

GitHub Copilot in the CLI é uma extensão do GitHub CLI que fornece uma interface semelhante a chat no terminal que permite fazer perguntas sobre comandos executados na linha de comando. Você pode pedir ao Copilot in the CLI para sugerir um comando para seu caso de uso, com gh copilot suggest, ou para explicar um comando sobre o qual você está curioso, com gh copilot explain.

Além disso, você pode usar gh copilot --help para ajuda geral ou gh copilot SUBCOMMAND --help para ajuda com um subcomando específico.

Pré-requisitos

Para acessar a GitHub Copilot in the CLI, você precisará do seguinte:

  • Assinatura do GitHub Copilot: você deve ter uma assinatura do GitHub Copilot ativa. Para obter mais informações, confira "Sobre a cobrança para o GitHub Copilot".
  • Acesso ao Copilot in the CLI: se você fizer parte de uma organização ou empresa com uma assinatura do GitHub Copilot Business ou GitHub Copilot Enterprise, o proprietário da organização ou empresa precisará conceder a você acesso ao Copilot in the CLI. Para obter mais informações, confira "Configuração do GitHub Copilot na CLI".
  • Instalar a Copilot in the CLI: você deve ter a GitHub CLI instalada. Para obter instruções de instalação para GitHub CLI, veja o repositório GitHub CLI.
  • Instalar a extensão do Copilot in the CLI: além disso, você deve ter a extensão do Copilot in the CLI instalada. Para obter mais informações, confira "Installing Copilot in the CLI".

Pedir ao Copilot in the CLI para explicar um comando

Você pode pedir ao Copilot in the CLI para explicar um comando para você executando:

Shell
gh copilot explain

Como alternativa, você pode adicionar o comando que deseja explicar diretamente ao prompt:

Shell
gh copilot explain "sudo apt-get"

O Copilot in the CLI pode ajudar explicando o que um comando faz em linguagem simples. Isso torna mais fácil para você entender a finalidade do comando e como ele funciona para um exemplo específico. Você não precisa passar pela documentação do comando porque a explicação inclui informações sobre o que o comando faz como entrada e produz como saída, e fornece exemplos práticos.

Pedir ao Copilot in the CLI para sugerir um comando

Você pode pedir ao Copilot in the CLI para sugerir um comando para você executando:

Shell
gh copilot suggest

Isso iniciará uma experiência interativa para obter o comando que você precisa. O Copilot in the CLI tem como objetivo sugerir comandos que ajudem você a executar as tarefas que você está tentando concluir. Para ajudar o Copilot in the CLI a fornecer melhores sugestões, você pode especificar o tipo de comando que está procurando (genérico git ou gh).

Se você já sabe qual comando precisa, também poderá incluí-lo no prompt. Por exemplo, se você quiser instalar o Git, poderá pedir ao Copilot in the CLI para sugerir um comando para você:

Shell
gh copilot suggest "Install git"

Se o resultado não for exatamente o que você está procurando, você poderá continuar revisando sua pergunta até que o comando retornado atenda às suas expectativas. Você pode fazer isso selecionando a opção Revisar comando.

Depois de gerar o comando perfeito para sua tarefa, você pode copiá-lo facilmente para a área de transferência para executá-lo quando precisar, selecionando a opção Copiar para área de transferência, ou executá-lo.

Executando o comando

Depois que Copilot in the CLI sugere um comando, você pode optar por executar o comando selecionando a opção Executar comando. Se você selecionar essa opção após executar gh copilot suggest para solicitar uma sugestão, o Copilot in the CLI copiará o comando para a área de transferência e sairá da sessão interativa automaticamente. Então, você pode colar o comando e executá-lo sozinho.

Se você quiser que o Copilot in the CLI execute os comandos para você, o alias ghcs gerado por gh copilot alias fornecerá esse suporte. Para obter mais informações sobre como configurar o alias ghcs, consulte "Configurando aliases para o Copilot in the CLI".

Quando você usa o alias ghcs e seleciona Executar comando, o Copilot in the CLI solicita sua confirmação antes de executar o comando. O prompt de confirmação usa No por padrão, mas você pode alterar sua preferência por meio da opção gh copilot config. Para obter mais informações, confira "Configurando o GitHub Copilot na CLI".

Se você confirmar, o comando será executado e salvo no histórico do shell para referência futura.

Configurando aliases para o Copilot in the CLI

Com gh copilot alias, você pode criar aliases para o Copilot in the CLI. Não é necessário aliases para usar o Copilot in the CLI, mas eles podem ser úteis pois requerem menos pressionamentos de tecla e ajudam na execução dos comandos sugeridos.

Você também pode usar os aliases fornecidos para empacotar gh copilot suggest e gh copilot explain. Os aliases fornecidos são ghcs e ghce. Para usar ghcs e ghce, você precisará adicionar algumas configurações de alias ao arquivo de configuração do shell.

Os exemplos a seguir mostram como adicionar as configurações de alias aos arquivos de configuração do Bash, do PowerShell e do Zsh.

Bash

Execute o seguinte comando para adicionar aliases ao arquivo de configuração do Bash:

Shell
echo 'eval "$(gh copilot alias -- bash)"' >> ~/.bashrc

PowerShell

Execute o seguinte comando para adicionar aliases ao seu perfil do PowerShell:

Shell
$GH_COPILOT_PROFILE = Join-Path -Path $(Split-Path -Path $PROFILE -Parent) -ChildPath "gh-copilot.ps1"
gh copilot alias -- pwsh | Out-File ( New-Item -Path $GH_COPILOT_PROFILE -Force )
echo ". `"$GH_COPILOT_PROFILE`"" >> $PROFILE

Zsh

Execute o seguinte comando para adicionar aliases ao arquivo de configuração do Zsh:

Shell
echo 'eval "$(gh copilot alias -- zsh)"' >> ~/.zshrc

Após configurar o alias, você pode executar o seguinte:

Shell
ghcs 'print "Hello world!"'

Compartilhar feedback sobre o Copilot in the CLI

Se você encontrar problemas ou limitações com o Copilot in the CLI, poderá fornecer feedback selecionando a opção Taxa de resposta no Copilot in the CLI.