> ## Documentation Index
> Fetch the complete documentation index at: https://helix-isolate-failing-index-entities.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# helix metrics

> Configure CLI telemetry and usage metrics collection

<div className="flex flex-wrap gap-2"><Badge color="gray" size="sm">Reference</Badge></div>

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

```bash theme={null}
helix metrics <SUBCOMMAND>
```

## Subcommands

| Subcommand | Description |
| - | - |
| `full` | Enable full metrics collection (prompts for an email address). |
| `basic` | Enable minimal anonymous metrics. |
| `off` | Disable all metrics collection. |
| `status` | Show current metrics configuration and when it was last updated. |

## Options

| Flag | Description | Default |
| - | - | - |
| `--json` | Print the result as JSON on stdout. `status` prints `level`, `userId`, and `lastUpdated` (Unix seconds); the others print `level`. | Off |

## Behavior

* The setting is saved in `~/.helix/metrics.toml` (or `$HELIX_HOME/metrics.toml`).
* `full` asks for an email address in a terminal and validates it before saving. Without a terminal, or with `--json`, it reads the address from stdin, one line at a time, until a valid one arrives.
* Local instances started by the CLI receive the same telemetry level.

### `helix metrics status` output

`status` prints `Level` (`full`, `basic`, or `off`), `User ID` (if set), and a relative `Last updated` time:

| Age | Format |
| - | - |
| 0–4 seconds | `just now` |
| 5–59 seconds | `<n>s ago` |
| 1–59 minutes | `<n>m ago` |
| 1–23 hours | `<n>h ago` |
| 1+ days | `<n>d ago` |

## Examples

```bash theme={null}
# Enable full metrics (prompts for email)
helix metrics full

# Enable anonymous basic metrics
helix metrics basic

# Disable all metrics
helix metrics off

# Show current state
helix metrics status
```

## Related

* [`helix update`](/cli/command-reference/update) — update the CLI.
* [`helix feedback`](/cli/command-reference/feedback) — send feedback to the Helix team.
* [CLI configuration](/cli/configuration) — other files the CLI keeps under `~/.helix/`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.