docs/content/github-cli/github-cli/github-cli-telemetry.md at main · github/docs · GitHub Skip to content Navigation Menu Sign in Appearance settings * Platform * AI CODE CREATION * GitHub Copilot Write better code with AI * GitHub Copilot app Direct agents from issue to merge * MCP Registry Integrate external tools * DEVELOPER WORKFLOWS * Actions Automate any workflow * Codespaces Instant dev environments * Issues Plan and track work * Code Review Manage code changes * Code Quality Enforce quality at merge * APPLICATION SECURITY * GitHub Advanced Security Find and fix vulnerabilities * Code security Secure your code as you build * Secret protection Stop leaks before they start * EXPLORE * Why GitHub * Documentation * Blog * Changelog * Marketplace View all features * Solutions * BY COMPANY SIZE * Enterprises * Small and medium teams * Startups * Nonprofits * BY USE CASE * App Modernization * DevSecOps * DevOps * CI/CD * View all use cases * BY INDUSTRY * Healthcare * Financial services * Manufacturing * Government * View all industries View all solutions * Resources * EXPLORE BY TOPIC * AI * Software Development * DevOps * Security * View all topics * EXPLORE BY TYPE * Customer stories * Events & webinars * Ebooks & reports * Business insights * GitHub Skills * SUPPORT & SERVICES * Documentation * Customer support * Community forum * Trust center * Partners View all resources * Open Source * COMMUNITY * GitHub Sponsors Fund open source developers * PROGRAMS * Security Lab * Maintainer Community * GitHub Stars * Archive Program * REPOSITORIES * Topics * Trending * Collections * Enterprise * ENTERPRISE SOLUTIONS * Enterprise platform AI-powered developer platform * AVAILABLE ADD-ONS * GitHub Advanced Security Enterprise-grade security features * Copilot for Business Enterprise-grade AI features * Premium Support Enterprise-grade 24/7 support * Pricing Search / Sign in Sign up Appearance settings You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert Uh oh! There was an error while loading. Please reload this page . github / docs Public * Notifications You must be signed in to change notification settings * Fork 68.6k * Star 20.8k * Code * Issues 37 * Pull requests 25 * Actions * Projects * Security and quality 0 * Insights Additional navigation options * Code * Issues * Pull requests * Actions * Projects * Security and quality * Insights Files Expand file tree main Breadcrumbs * docs * / content * / github-cli * / github-cli / github-cli-telemetry.md Copy path Blame More file actions Blame More file actions Latest commit   History History History 131 lines (101 loc) · 5.35 KB main Breadcrumbs * docs * / content * / github-cli * / github-cli / github-cli-telemetry.md Copy path Top File metadata and controls * Preview * Code * Blame 131 lines (101 loc) · 5.35 KB Raw Copy raw file Download raw file Outline Edit and raw actions title GitHub CLI telemetry intro {% data variables.product.prodname_cli %} sends pseudonymous telemetry to help improve the product. Learn what data is collected and how to opt out. versions fpt ghes ghec * * * contentType concepts category Learn the basics Why {% data variables.product.prodname_cli %} collects telemetry As agentic adoption of {% data variables.product.prodname_cli %} grows, visibility into how features are used in practice helps {% data variables.product.github %} improve the product. Telemetry data helps us prioritize development work and evaluate whether features meet real user needs. For example, when a new subcommand is shipped, telemetry reveals whether anyone is using it and how. If adoption is low, that signals a need to revisit the feature's discoverability or design. If a subcommand sees high usage with certain flags, that shows where to invest in a better experience. Important Telemetry data is not collected when the target is {% data variables.product.prodname_ghe_server %} or the user has authenticated {% data variables.product.prodname_cli %} with a {% data variables.product.prodname_ghe_server %} host. Reviewing telemetry {% data variables.product.prodname_cli %} is open source. You can review the telemetry implementation in the cli/cli repository. If you want to see exactly what would be sent without actually sending it, you can enable logging mode using either an environment variable or a configuration option. Environment variable: export GH_TELEMETRY=log CLI configuration: gh config set telemetry log In logging mode, the JSON payload that would normally be sent is printed to stderr instead. This lets you inspect every field before deciding whether to keep telemetry enabled. For example: GH_TELEMETRY=log gh skill install github/awesome-copilot git-commit --agent github-copilot --scope project This prints something like: 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" } } ] } Some commands may include additional telemetry dimensions based on the context. In this example, the skill_ fields are included because the repo_visibility is public . Note This command can only log telemetry for the exact command and context in which it ran. Changing environment variables or authenticated accounts may change the events and event dimensions included in the payload. How to opt out You can opt out of the telemetry you see in the log mode described above using either an environment variable or a configuration option. Environment variables: export GH_TELEMETRY=false Any falsy value works: 0 , false , disabled , or an empty string. You can also use the DO_NOT_TRACK convention: export DO_NOT_TRACK=true CLI configuration: gh config set telemetry disabled Note The environment variables take precedence over the configuration value. Where data is sent Telemetry events are sent to {% data variables.product.company_short %}'s internal analytics infrastructure. For more information about how {% data variables.product.company_short %} handles your data, see AUTOTITLE . Additional information {% data variables.product.prodname_cli %} allows you to add features to the product by installing {% data variables.product.company_short %}-authored and third-party extensions, including agents. These extensions may collect their own usage data and are not controlled by opting out. Consult the specific extension's documentation to learn about its telemetry reporting and whether it can be disabled. This page describes client-side data collection for {% data variables.product.prodname_cli %} ( gh ). It does not apply to {% data variables.product.prodname_copilot %} or {% data variables.copilot.copilot_cli %}, which handle data collection separately. For information on the {% data variables.copilot.copilot_cli %}, see AUTOTITLE and AUTOTITLE . Footer (c) 2026 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Community * Docs * Contact * Manage cookies * Do not share my personal information You can’t perform that action at this time.