Skip to content

Add CLI telemetry documentation #5039

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

Merged
ethanpalm merged 2 commits into from
Apr 5, 2026
+23 −0
Merged

Add CLI telemetry documentation #5039

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
680074a
Add CLI telemetry documentation
mintlify[bot] Apr 1, 2026
6687b84
Apply suggestions from code review
ethanpalm Apr 5, 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
23 changes: 23 additions & 0 deletions installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,29 @@ Display the current CLI and client version:
mint version
```

## Telemetry

The CLI collects anonymous usage telemetry to help improve Mintlify. Telemetry data includes the command name, CLI version, operating system, and architecture. Mintlify does **not** collect personally identifiable information, project content, or file paths.

By default, the CLI collects telemetry data. You can opt out at any time by using the `--telemetry` flag:

```bash
# Disable telemetry
mint --telemetry false

# Re-enable telemetry
mint --telemetry true
```

You can also disable telemetry by setting one of these environment variables:

| Variable | Value | Description |
| --- | --- | --- |
| `MINTLIFY_TELEMETRY_DISABLED` | `1` | Disable Mintlify CLI telemetry. |
| `DO_NOT_TRACK` | `1` | Disable telemetry using the [Console Do Not Track](https://consoledonottrack.com/) standard. |

Your preference saves in `~/.config/mintlify/config.json` and persists across CLI sessions.

## Formatting

While developing locally, we recommend using extensions in your IDE to recognize and format MDX files.
Expand Down
Loading