Por que GitHub CLI coleta telemetria
À medida que a adoção ativa de GitHub CLI aumenta, a visibilidade de como os recursos são usados na prática ajuda GitHub a aprimorar o produto. Os dados de telemetria nos ajudam a priorizar o trabalho de desenvolvimento e avaliar se os recursos atendem às necessidades reais do usuário.
Por exemplo, quando um novo subcomando é enviado, a telemetria revela se alguém está usando e como. Se a adoção for baixa, isso sinalizará a necessidade de revisitar a descoberta ou o design do recurso. Se um subcomando apresentar alta taxa de uso com determinadas opções, isso indica onde investir para uma melhor experiência.
Importante
Os dados de telemetria não são coletados quando o destino é GitHub Enterprise Server ou o usuário autenticou-se GitHub CLI com um host GitHub Enterprise Server.
Revisão da telemetria
GitHub CLI é código aberto. Você pode examinar a implementação de telemetria no repositório [cli/cli](https://github.com/cli/cli) . Se você quiser ver exatamente o que seria enviado sem realmente enviá-lo, poderá habilitar o modo de registro em log usando uma variável de ambiente ou uma opção de configuração.
**Variável de ambiente:**
export GH_TELEMETRY=log
**Configuração da CLI:**
gh config set telemetry log
No modo de registro, o payload JSON que normalmente seria enviada é impressa no stderr. Isso permite inspecionar todos os campos antes de decidir se deseja manter a telemetria habilitada. Por exemplo:
GH_TELEMETRY=log gh skill install github/awesome-copilot git-commit --agent github-copilot --scope project
Isso imprime algo como:
Telemetry payload:
{
"events": [
{
"type": "skill_install",
"dimensions": {
"agent": "",
"agent_hosts": "github-copilot",
"architecture": "arm64",
"ci": "false",
"device_id": "1e9a73a6-c8bd-4e1e-be02-78f4b11de4e1",
"github_actions": "false",
"invocation_id": "96d4862f-26c9-4385-961d-d749ae519c81",
"is_tty": "true",
"os": "darwin",
"repo_visibility": "public",
"skill_host_type": "github.com",
"skill_names": "git-commit",
"skill_owner": "github",
"skill_repo": "awesome-copilot",
"timestamp": "2026-04-24T11:54:51.057Z",
"upstream_source": "none",
"version": "2.91.0"
}
},
{
"type": "command_invocation",
"dimensions": {
"agent": "",
"architecture": "arm64",
"ci": "false",
"command": "gh skill install",
"device_id": "1e9a73a6-c8bd-4e1e-be02-78f4b11de4e1",
"flags": "agent,scope",
"github_actions": "false",
"invocation_id": "96d4862f-26c9-4385-961d-d749ae519c81",
"is_tty": "true",
"os": "darwin",
"timestamp": "2026-04-24T11:54:51.057Z",
"version": "2.91.0"
}
}
]
}
Alguns comandos podem incluir dimensões de telemetria adicionais com base no contexto. Neste exemplo, os skill_ campos são incluídos porque o repo_visibility é public.
Observação
Esse comando só pode registrar a telemetria para o comando exato e o contexto no qual ele foi executado. Alterar variáveis de ambiente ou contas autenticadas pode alterar os eventos e as dimensões de evento incluídas no conteúdo.
Como recusar
Você pode desativar a telemetria exibida no modo log descrito acima usando uma variável de ambiente ou uma opção de configuração.
**Variáveis de ambiente:**
export GH_TELEMETRY=false
Qualquer valor falso funciona: 0, , falseou disableduma cadeia de caracteres vazia. Você também pode usar a DO_NOT_TRACK convenção:
export DO_NOT_TRACK=true
**Configuração da CLI:**
gh config set telemetry disabled
Observação
As variáveis de ambiente têm precedência sobre o valor de configuração.
Para onde os dados são enviados
Os eventos de telemetria são enviados para a GitHubinfraestrutura de análise interna. Para obter mais informações sobre como GitHub lida com seus dados, consulte Declaração Geral de Privacidade do GitHub.
Informações adicionais
GitHub CLI permite adicionar recursos ao produto instalando extensões de autoria de GitHub e de terceiros, incluindo agentes. Essas extensões podem coletar seus próprios dados de uso e não são controladas pela recusa. Consulte a documentação da extensão específica para saber mais sobre seus relatórios de telemetria e se ela pode ser desabilitada.
Esta página descreve a coleta de dados do lado do cliente para GitHub CLI (gh). Ele não se aplica a GitHub Copilot ou CLI do GitHub Copilot, que manipula a coleta de dados separadamente. Para obter informações sobre o CLI do GitHub Copilot, consulte AUTOTITLE e Uso responsável da CLI de GitHub Copilot.