GitHub CLI agora coleta telemetria pseudonimizada

• A telemetria pseudonimizada é enviada pelo GitHub CLI com o objetivo de dar visibilidade ao uso de recursos e apoiar melhorias no produto
• Adoção de subcommands e padrões de uso de flags são usados para definir prioridades de trabalho, avaliar se as necessidades dos usuários estão sendo atendidas e revisar discoverability e design
• Com a implementação open source, é possível revisar diretamente o código de telemetria no repositório cli/cli, e no modo de logging verificar o payload JSON antes do envio real
• O opt-out pode ser feito com a variável de ambiente GH_TELEMETRY=false, DO_NOT_TRACK=true ou gh config set telemetry disabled, e as variáveis de ambiente têm prioridade sobre a config
• Os eventos de telemetria são enviados para a infraestrutura interna de análise do GitHub, e esta página trata apenas da coleta de dados no lado do cliente do gh; extensions e Copilot CLI são tratados separadamente

---

Telemetria

• O GitHub CLI envia telemetria pseudonimizada com o objetivo de apoiar melhorias no produto
• As informações são fornecidas para que os usuários entendam quais dados são enviados e por quê

Por que a telemetria é coletada

• É mencionada a necessidade de obter visibilidade sobre o uso dos recursos do GitHub CLI, especialmente com o aumento da adoção agentic, para entender como ele é realmente usado
  • A equipe usa esses dados para definir prioridades de trabalho
  • Avaliar se os recursos estão de fato atendendo às necessidades dos usuários
• Também é declarado o objetivo de verificar a adoção após o lançamento de novos subcommands
  • Se quase ninguém usar, pode ser necessário revisar a discoverability ou o design desse recurso
  • Se for identificado alto uso com determinadas flags, isso ajuda a encontrar onde investir em uma experiência melhor

Revisão da telemetria

• Como o GitHub CLI é open source, é possível revisar diretamente a implementação de telemetria no repositório cli/cli
• Para verificar quais dados seriam enviados sem realmente enviá-los, é possível usar o modo de logging
  • Há suporte via variável de ambiente
    • export GH_TELEMETRY=log
  • Há suporte via configuração da CLI
    • gh config set telemetry log
• No modo de logging, o payload JSON que normalmente seria enviado é exibido no stderr
  • É possível inspecionar cada campo antes de decidir se deseja manter a telemetria ativada
  • É apresentado como comando de exemplo GH_TELEMETRY=log gh repo list --archived
• São especificadas as informações de evento incluídas no payload de exemplo
  • Tipo de evento command_invocation
  • Como itens de dimensions, inclui agent, architecture, command, device_id, flags, invocation_id, is_tty, os, timestamp, version
  • Como valores de exemplo, são mostrados architecture: arm64, command: gh repo list, flags: archived, os: darwin, version: 2.91.0
• Esse comando só pode registrar a telemetria referente ao comando exato executado e ao contexto
  • Se as variáveis de ambiente mudarem, os events e event dimensions incluídos no payload também podem mudar
  • Os itens incluídos também podem mudar se a conta autenticada for alterada

Como fazer opt-out

• É possível fazer opt-out da telemetria verificada no modo de logging
• Há suporte via variável de ambiente
  • export GH_TELEMETRY=false
  • Valores falsy como 0, false, disabled e string vazia podem ser usados
  • A convenção DO_NOT_TRACK também é suportada, com o exemplo export DO_NOT_TRACK=true
• Há suporte via configuração da CLI
  • gh config set telemetry disabled
• As variáveis de ambiente têm prioridade sobre o valor de config

Para onde os dados são enviados

• Os eventos de telemetria são enviados para a infraestrutura interna de análise do GitHub
• Para mais informações sobre como os dados são processados, é indicado consultar a GitHub General Privacy Statement

Informações adicionais

• O GitHub CLI oferece suporte à adição de recursos por meio da instalação de extensions do GitHub e de terceiros, incluindo agents
• Essas extensions podem coletar seus próprios dados de uso
  • Isso não é controlado pela configuração de opt-out
  • É necessário verificar a documentação de cada extension para saber como ela reporta telemetria e se é possível desativá-la
• Esta página trata apenas da coleta de dados no lado do cliente do GitHub CLI gh
  • Não se aplica ao GitHub Copilot nem ao Copilot CLI
  • O Copilot CLI lida com a coleta de dados separadamente
  • São indicados Using GitHub Copilot CLI e Responsible Use of the GitHub Copilot CLI como locais com informações relacionadas