Reference
Configure CLI telemetry and usage metrics collection. Settings are stored in the per-user metrics
config and apply to every project on this machine.
Usage
Subcommands
Options
Behavior
- The setting is saved in
~/.helix/metrics.toml(or$HELIX_HOME/metrics.toml). fullasks for an email address in a terminal and validates it before saving. Without a terminal, or with--json, it reads lines from piped stdin until a valid address arrives, for exampleecho you@example.com | helix metrics full --json; if stdin is a terminal, it fails and asks you to pipe the address.- Local instances started by the CLI receive the same telemetry level.
DO_NOT_TRACKset to anything but empty,0,falseornoturns telemetry off for the CLI and the instances it starts, whatever the saved level.HELIX_TELEMETRY_LEVELsets the level of a server or embedded database:full,basic(oron,true,yes,1) oroff(orfalse,no,0).basicidentifies the sender only by pseudonymous IDs: a random installation ID, a hash of the git repository, andHELIX_DEPLOYMENT_IDor a hash of the S3 bucket. Query events carry each query’s shape with every value redacted, its latency and outcome, and the first word of the caller’sUser-Agent. No repository or bucket names, parameters, results or IP addresses are stored.
helix metrics status output
status prints Level (full, basic, or off), User ID (if set), and a relative Last updated time:
Examples
Related
helix update— update the CLI.helix feedback— send feedback to the Helix team.- CLI configuration — other files the CLI keeps under
~/.helix/.