diff --git a/installation.mdx b/installation.mdx index 68eca503e..87fbdfb5c 100644 --- a/installation.mdx +++ b/installation.mdx @@ -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.