Skip to main content

Uso responsável da CLI de GitHub Copilot

Saiba como usar CLI do GitHub Copilot com responsabilidade entendendo suas finalidades, funcionalidades e limitações.

Quem pode usar esse recurso?

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

Sobre o CLI do GitHub Copilot

          CLI do GitHub Copilot fornece uma interface semelhante ao chat no terminal que pode criar e modificar arquivos de forma autônoma em seu computador e executar comandos. Você pode solicitar Copilot a execução de qualquer ação nos arquivos no active directory.

          CLI do GitHub Copilot pode gerar alterações personalizadas com base em sua descrição e configurações, incluindo tarefas como correções de bug, implementação de novos recursos incrementais, protótipos, documentação e manutenção de base de código.

Ao trabalhar em sua tarefa, o Copilot agente tem acesso ao ambiente do terminal local, onde pode fazer alterações no código, executar testes automatizados, executar linters e executar comandos disponíveis em seu ambiente.

O agente foi avaliado em uma variedade de linguagens de programação, com o inglês como o idioma principal com suporte.

O agente funciona usando uma combinação de processamento de linguagem natural e machine learning para entender sua tarefa e fazer alterações em uma base de código para concluir a tarefa. Esse processo pode ser dividido em várias etapas.

Processamento de entrada

Sua entrada é combinada com informações contextuais relevantes para formar um prompt. Esse prompt é enviado para um modelo de linguagem grande para processamento. As entradas podem assumir a forma de linguagem natural simples, snippets de código ou referências a arquivos em seu terminal.

Análise de modelo de linguagem

O prompt então percorre todo um grande modelo de linguagem, que é uma rede neural treinada em um grande corpo de dados. O modelo de linguagem analisa o prompt de entrada para ajudar o agente a raciocinar sobre a tarefa e usar as ferramentas necessárias.

Geração de resposta

O modelo de linguagem gera uma resposta com base na análise da solicitação. Essa resposta pode assumir a forma de sugestões de linguagem natural, sugestões de código, modificações de arquivo e execuções de comando.

Formatação de saída

A resposta gerada pelo agente é formatada e apresentada a você. CLI do GitHub Copilot usa realce de sintaxe, recuo e outros recursos de formatação para adicionar clareza à resposta gerada.

O agente também pode querer executar comandos em seu ambiente local e criar, editar ou excluir arquivos em seu sistema de arquivos para concluir sua tarefa.

Você pode fornecer comentários ao agente depois que ele retornar uma resposta na janela de chat interativa. Em seguida, o agente reenviará esses comentários ao modelo de linguagem para análise posterior. Depois que o agente concluir as alterações com base nos comentários, o agente retornará uma resposta adicional.

Copilot destina-se a fornecer a solução mais relevante para a resolução de tarefas. Mas, nem sempre ele consegue fornecer a resposta que você está procurando. Você é responsável por revisar e validar as respostas geradas Copilot para garantir que elas sejam precisas e apropriadas. Para obter mais informações, consulte a seção Aprimorando os resultados de CLI do GitHub Copilot, mais adiante neste artigo.

Casos de uso para CLI do GitHub Copilot

Você pode delegar uma tarefa para Copilot uma variedade de cenários, incluindo, mas não se limitando a:

  •         **Manutenção da base de código:** Lidar com correções relacionadas à segurança, atualizações de dependência e refatoração direcionada.
    
  •         **Documentação:** Atualizando e criando uma nova documentação.
    
  •         **Desenvolvimento de recursos:** Implementando solicitações de recursos incrementais.
    
  •         **Melhorando a cobertura do teste:** Desenvolvendo conjuntos de testes adicionais para gerenciamento de qualidade.
    
  •         **Criação de novos projetos:** Novos conceitos do Greenfielding.
    
  •         **Configurando seu ambiente:** Executando comandos em seu terminal para configurar seu ambiente local para trabalhar em projetos existentes
    
  •         **Localize o comando certo para executar uma tarefa:**Copilot pode fornecer sugestões de comandos para executar tarefas que você está tentando concluir.
    
  •         **Explicar um comando desconhecido:**Copilot pode fornecer uma descrição de linguagem natural da funcionalidade e da finalidade de um comando.
    

Aprimorando os resultados de CLI do GitHub Copilot

          CLI do GitHub Copilot pode dar suporte a uma ampla gama de tarefas. Para aprimorar as respostas recebidas e resolver algumas das limitações do agente, há várias medidas que você pode adotar.

Para obter mais informações sobre limitações, consulte a seção Limitações de CLI do GitHub Copilot, posteriormente neste artigo.

Verifique se o escopo das tarefas está bem definido

          CLI do GitHub Copilot aproveita o prompt como contexto de chave ao concluir uma tarefa. Quanto mais claro e com mais escopo o prompt que você fornecer, melhores serão os resultados obtidos. Um prompt ideal inclui:
  • Uma descrição clara do problema a ser resolvido ou o trabalho necessário.
  • Critérios de aceitação completos sobre o que é uma boa solução (por exemplo, deve haver testes de unidade?).
  • Dicas ou indicadores sobre quais arquivos precisam ser alterados.

Personalizar sua experiência com contexto adicional

          CLI do GitHub Copilot aproveita o prompt e o código do repositório como contexto ao gerar alterações sugeridas. Para aprimorar Copiloto desempenho, considere implementar instruções personalizadas Copilot para ajudar o agente a entender melhor seu projeto e como criar, testar e validar suas alterações. Para saber mais, confira [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-custom-instructions).

Usar CLI do GitHub Copilot como uma ferramenta, não como uma substituição

Embora CLI do GitHub Copilot possa ser uma ferramenta poderosa para gerar código e documentação, é importante usá-lo como uma ferramenta, em vez de uma substituição para programação humana. Você sempre deve examinar e verificar os comandos gerados CLI do GitHub Copilot para garantir que ele atenda aos seus requisitos e esteja livre de erros ou problemas de segurança.

Use práticas seguras de codificação e revisão de código

Embora CLI do GitHub Copilot possa gerar código sintaticamente correto, ele pode nem sempre ser seguro. Você sempre deve seguir as práticas recomendadas para codificação segura, como evitar senhas embutidas em código ou vulnerabilidades de injeção de SQL, além de seguir as práticas recomendadas de revisão de código, para resolver as limitações do agente. Você deve sempre tomar as mesmas precauções que tomaria com qualquer código que escrevesse que utilizasse material não originado de maneira independente, incluindo precauções para garantir sua adequação. Isso inclui testes rigorosos, verificação de IP e acompanhamento de vulnerabilidades de segurança.

Fornecer comentários

Se você encontrar problemas ou limitações, CLI do GitHub Copilotrecomendamos que você forneça comentários usando o /feedback comando.

Medidas de segurança para CLI do GitHub Copilot

Restrição de Copilotpermissões

Por padrão, CLI do Copilot:

  • Só tem acesso a arquivos e pastas dentro e abaixo do diretório do qual CLI do GitHub Copilot foi invocado. Verifique se você confia nos arquivos neste diretório. Se Copilot quiser acessar arquivos fora do diretório atual, ele solicitará permissão. Conceda permissão somente se você confiar no conteúdo desse diretório.
  • Solicitará permissão antes de modificar arquivos. Verifique se ele está modificando os arquivos corretos antes de conceder permissão.
  • Solicitará permissão antes de executar comandos que podem ser perigosos. Examine esses comandos cuidadosamente antes de conceder a ele permissão para execução.

Você pode conceder CLI do Copilot permissões específicas ou todas as permissões usando as várias opções de linha de comando: por exemplo, --allow-tool=[TOOLS...], ou --allow-all-tools``--allow-all seu comando de barra equivalente /allow-all para uso em uma sessão interativa). Para saber mais, confira referência de comando da CLI GitHub Copilot. Normalmente, ao usar CLI do Copilot no modo piloto automático, você concederá permissões completas para permitir que ele conclua uma tarefa de forma autônoma, sem exigir que você aprove a atividade enquanto ela funciona na tarefa. Para saber mais, confira Permitindo que GitHub Copilot CLI funcione de forma autônoma.

Para obter mais informações sobre as práticas de segurança durante o uso CLI do GitHub Copilot, consulte "Considerações de segurança" no Sobre GitHub Copilot CLI.

Manipulação de dados ao usar seu próprio provedor de modelos

Quando você configura CLI do Copilot para usar seu próprio provedor de modelos, seus prompts, contexto de código e respostas geradas são enviados diretamente para o provedor configurado. Eles não são roteado.GitHub Você é responsável por revisar e cumprir os termos de serviço e as políticas de tratamento de dados do provedor escolhido.

Telemetria

Quando você usa seu próprio provedor de modelos sem modo offline, CLI do Copilot continua a enviar telemetria como GitHub de costume. Essa telemetria não inclui seus prompts ou código, mas inclui metadados de uso.

Se você habilitar o modo offline definindo a COPILOT_OFFLINE variável de ambiente como true, toda a telemetria será desabilitada. No modo offline, CLI do Copilot só faz solicitações de rede para o provedor de modelo configurado.

Autenticação e disponibilidade de recursos

          GitHub A autenticação não é necessária ao usar seu próprio provedor de modelos (BYOK). Sem GitHub autenticação, os seguintes recursos não estão disponíveis:

* /delegate, que entrega a sessão para GitHubo lado do servidor Copilot

  • O GitHub servidor MCP
  •         GitHub Pesquisa de código
    

No modo offline, ferramentas baseadas na Web, como web_fetch e GitHub Pesquisa de Código, também são desabilitadas.

Nenhum fallback para GitHubmodelos hospedados

Se a configuração do provedor de modelos for inválida, CLI do Copilot sairá com um erro. Ele não faz fallback para GitHubmodelos hospedados. Falhas comuns, como conexão recusada, erros de autenticação, modelo não encontrado e tempos limite, produzem mensagens amigáveis com diretrizes acionáveis.

Limitações de CLI do GitHub Copilot

Dependendo de fatores como a base de código e os dados de entrada, você poderá experimentar diferentes níveis de desempenho ao usar CLI do GitHub Copilot. As informações a seguir foram projetadas para ajudá-lo a entender as limitações do sistema e os principais conceitos sobre o desempenho conforme se aplicam a CLI do GitHub Copilot.

Escopo limitado

O modelo de linguagem usado por CLI do GitHub Copilot foi treinado em uma grande quantidade de código, mas ainda tem um escopo limitado e pode não ser capaz de lidar com determinadas estruturas de código ou linguagens de programação obscuras. Para cada linguagem, a qualidade das sugestões recebidas pode depender do volume e da diversidade de dados de treinamento para essa linguagem.

Possíveis desvios

O modelo de linguagem utilizado pelos dados de treinamento de CLI do GitHub Copilot e pelo contexto coletado pelo modelo de linguagem de grande porte pode conter preconceitos e erros que podem ser perpetuados pela ferramenta. Além disso, CLI do GitHub Copilot pode ser tendencioso em relação a determinadas linguagens de programação ou estilos de codificação, o que pode levar a sugestões abaixo do ideal ou incompletas.

Riscos à segurança

          CLI do GitHub Copilot gera código e linguagem natural com base no contexto de um problema ou comentário em um repositório, que pode potencialmente expor informações confidenciais ou vulnerabilidades se não for usado com cuidado. Você deve ter cuidado para examinar todas as saídas geradas por CLI do GitHub Copilot completo antes da mesclagem.

Código impreciso

          CLI do GitHub Copilot pode gerar um código que parece ser válido, mas pode não ser semanticamente ou sintaticamente correto ou não refletir com precisão a intenção do desenvolvedor.

Para atenuar o risco de código impreciso, revise e teste cuidadosamente o código gerado, ainda mais ao lidar com aplicativos críticos ou confidenciais. Você também deve garantir que o código gerado siga práticas recomendadas e os padrões de design e se encaixe na arquitetura geral e no estilo da base de código.

Código público

          CLI do GitHub Copilot pode gerar código que seja igual ou semelhante ao código público, ainda que a política "Sugestões correspondentes ao código público" esteja definida como "Bloquear". Confira [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-suggestions-matching-public-code).

Os usuários precisam avaliar possíveis obrigações legais e regulatórias específicas ao usar serviços e soluções de IA, o que pode não ser apropriado para uso em todos os setores ou cenários. Além disso, serviços ou soluções de IA não são projetados para e não podem ser usados de maneiras proibidas nos termos de serviço aplicáveis e nos códigos de conduta relevantes.

Gerenciamento de riscos e responsabilidade do usuário na execução de comandos

É necessário cuidado adicional ao solicitar ou permitir a execução CLI do GitHub Copilot de um comando, especialmente em relação à potencial destrutiva de alguns comandos sugeridos. Você pode encontrar comandos de exclusão de arquivo ou formatação da unidade de disco rígido que podem causar problemas se usados incorretamente. Embora esses comandos possam ser necessários em determinados cenários, você precisa ter cuidado ao aceitá-los e executá-los.

Além disso, você é responsável pelos comandos executados por CLI do GitHub Copilot. É inteiramente sua decisão se deve usar comandos gerados por CLI do GitHub Copilot. Apesar da presença de mecanismos de segurança à prova de falhas, você deve entender que a execução de comandos tem riscos inerentes. CLI do GitHub Copilot fornece um conjunto de ferramentas poderoso, mas você deve abordar suas recomendações com cuidado e garantir que os comandos estejam alinhados com suas intenções e requisitos.

Leitura adicional

  •         [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)
    
  •         [
            GitHub Copilot Central de Confiabilidade](https://copilot.github.trust.page/)