Skip to content

🤖 feat: add Usage Telemetry toggle to Settings → General #3850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
asm wants to merge 2 commits into
base: main
Choose a base branch
from
Open

🤖 feat: add Usage Telemetry toggle to Settings → General #3850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5daedcb
🤖 feat: Usage Telemetry toggle in Settings → General
asm Aug 31, 2026
db22308
🤖 fix: apply telemetry state from the persisted truth at apply time
asm Aug 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/reference/telemetry.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,15 @@ All telemetry events include basic system information:

## Disabling telemetry

To disable telemetry, set `XUM_DISABLE_TELEMETRY` before starting the app:
Toggle **Usage Telemetry** off in **Settings → General**. The change applies immediately (no restart) and persists as `telemetryEnabled: false` in the active Xum home's `config.json` — `~/.xum` by default, or the directory `XUM_ROOT` / an existing legacy `~/.mux` install points at. Opting out also drops a `telemetry_opt_out` marker file next to `config.json`, so the choice survives running an older Xum build whose settings writer doesn't know the field; toggling telemetry back on removes it. Builds that predate this toggle only honor the environment variable — if you opt out and plan to keep running such a build, also set `XUM_DISABLE_TELEMETRY=1`; the marker restores your choice for current builds once you upgrade again.

Alternatively, set `XUM_DISABLE_TELEMETRY` to exactly `1` before starting the app (other values like `true` are ignored):

```bash
XUM_DISABLE_TELEMETRY=1 xum
```

This disables telemetry collection at the backend level.
The environment variable is a hard override: when set to `1`, telemetry stays off regardless of the Settings toggle, and the toggle renders disabled with a note saying so. Both switches disable collection at the backend level.

## Source code

Expand Down
Loading