Skip to content

Update from code changes: CLI telemetry email attribution #7274

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
mintlify wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update from code changes: CLI telemetry email attribution #7274

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
0b62600
docs: CLI telemetry includes account email for logged-in users
mintlify[bot] Sep 5, 2026
456dee9
docs: shorten zh CLI commands page description for SEO
mintlify[bot] Sep 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
4 changes: 2 additions & 2 deletions cli/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

| Flag | Description |
| --- | --- |
| `--telemetry`, `-t` | Enable or disable anonymous usage telemetry. |
| `--telemetry`, `-t` | Enable or disable usage telemetry. |
| `--help`, `-h` | Display help for the command. |
| `--version`, `-v` | Display the CLI version. Alias for `mint version`. |

Expand Down Expand Up @@ -93,9 +93,9 @@

| Client | Global configuration | Project configuration |
| --- | --- | --- |
| Claude Code | `~/.claude.json` | `.mcp.json` |

Check warning on line 96 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L96 

Use 'Claude' instead of 'claude'.
| Cursor | `~/.cursor/mcp.json` | `.cursor/mcp.json` |
| VS Code | User `mcp.json` | `.vscode/mcp.json` |

Check warning on line 98 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L98 

Use 'VSCode' instead of 'vscode'.
| Codex | `~/.codex/config.toml` | `.codex/config.toml` |
| OpenCode | `~/.config/opencode/opencode.json` | `opencode.json` |
| Windsurf | `~/.codeium/windsurf/mcp_config.json` | Global only |
Expand Down Expand Up @@ -204,7 +204,7 @@

Add the `TXT` records first, then add the `CNAME` once the verification records validate. See [Custom domain](/customize/custom-domain) for full DNS setup instructions, apex domain requirements, and TLS provisioning details.

If the command fails with `Domain is already in use by another deployment in your organization` or `Domain is already claimed by another organization`, the domain is bound to another Mintlify deployment. See [Add domain fails with "Domain is already claimed by another organization"](/help-center/domain-already-claimed-by-another-organization) to release it and re-add it.

Check warning on line 207 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L207 

In general, use active voice instead of passive voice ('is bound').

<Note>
If some `TXT` records are still generating when the command exits, check the [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) page in your dashboard for the remaining values.
Expand Down Expand Up @@ -351,7 +351,7 @@

### `mint analytics stats`

Display top-line KPIs for a date range: views, visitors, searches, feedback, and assistant usage. The output reports human and agent traffic separately.

Check warning on line 354 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L354 

Did you really mean 'KPIs'?

```bash
mint analytics stats [flags]
Expand Down Expand Up @@ -500,7 +500,7 @@
| `--check-redirects` | Also check that redirect destinations in `docs.json` resolve to valid paths. |
| `--check-snippets` | Also check links inside `<Snippet>` components. |

Pass `--files` to limit the check to specific pages. This is useful for validating a single page you just edited or scoping checks to a directory in CI. When `--files` is set with `--check-external`, only external URLs on the selected pages are fetched.

Check warning on line 503 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L503 

In general, use active voice instead of passive voice ('are fetched').

```bash
# Check a specific page
Expand Down Expand Up @@ -671,13 +671,13 @@
mint format
```

Run the command from the root of your docs project. It walks every subdirectory, skipping paths matched by `.gitignore` and any Mintlify ignore rules. Files that already match the canonical output are left untouched.

Check warning on line 674 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L674 

In general, use active voice instead of passive voice ('are left').

<Warning>
`mint format` rewrites files in place. Commit or stash your changes before running it so you can review the diff.
</Warning>

When it finishes, the command prints how many MDX files were reformatted and how many failed to parse. If any file fails, the command exits with code `1` and prints the file path and error, so you can run it in CI to enforce consistent formatting.

Check warning on line 680 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L680 

In general, use active voice instead of passive voice ('were reformatted').

---

Expand Down Expand Up @@ -731,7 +731,7 @@

## 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.
The CLI collects usage telemetry to help improve Mintlify. Telemetry data includes the command name, CLI version, operating system, and architecture. If you are logged in, telemetry events also include your account email address. Logged-out usage stays anonymous, and logging out removes your stored email. Mintlify does **not** collect project content or file paths.

Check warning on line 734 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L734 

In general, use active voice instead of passive voice ('are logged').

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

Expand Down
4 changes: 2 additions & 2 deletions es/cli/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Estos flags están disponibles en todos los comandos.

| Flag | Descripción |
| --- | --- |
| `--telemetry`, `-t` | Habilitar o deshabilitar la telemetría anónima de uso. |
| `--telemetry`, `-t` | Habilitar o deshabilitar la telemetría de uso. |
| `--help`, `-h` | Mostrar la ayuda del comando. |
| `--version`, `-v` | Mostrar la versión de la CLI. Alias de `mint version`. |

Expand Down Expand Up @@ -821,7 +821,7 @@ Estos comandos están disponibles para ejecutar pero aún no son funcionales. Ej
## Telemetría
</div>

La CLI recopila telemetría anónima de uso para ayudar a mejorar Mintlify. Los datos de telemetría incluyen el nombre del comando, la versión de la CLI, el sistema operativo y la arquitectura. Mintlify **no** recopila información de identificación personal, contenido del proyecto ni rutas de archivos.
La CLI recopila telemetría de uso para ayudar a mejorar Mintlify. Los datos de telemetría incluyen el nombre del comando, la versión de la CLI, el sistema operativo y la arquitectura. Si has iniciado sesión, los eventos de telemetría también incluyen el correo electrónico de tu cuenta. El uso sin sesión iniciada permanece anónimo, y cerrar sesión elimina tu correo electrónico almacenado. Mintlify **no** recopila contenido del proyecto ni rutas de archivos.

Por defecto, la CLI recopila datos de telemetría. Puedes desactivarla en cualquier momento usando el flag `--telemetry`:

Expand Down
4 changes: 2 additions & 2 deletions fr/cli/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Ces flags sont disponibles pour toutes les commandes.

| Flag | Description |
| --- | --- |
| `--telemetry`, `-t` | Activer ou désactiver la télémétrie anonyme d'utilisation. |
| `--telemetry`, `-t` | Activer ou désactiver la télémétrie d'utilisation. |
| `--help`, `-h` | Afficher l'aide de la commande. |
| `--version`, `-v` | Afficher la version de la CLI. Alias de `mint version`. |

Expand Down Expand Up @@ -823,7 +823,7 @@ Ces commandes sont disponibles mais ne sont pas encore fonctionnelles. Les exéc
## Télémétrie
</div>

La CLI collecte des données de télémétrie anonymes pour aider à améliorer Mintlify. Les données de télémétrie incluent le nom de la commande, la version de la CLI, le système d'exploitation et l'architecture. Mintlify ne collecte **pas** d'informations personnellement identifiables, de contenu de projet ni de chemins de fichiers.
La CLI collecte des données de télémétrie d'utilisation pour aider à améliorer Mintlify. Les données de télémétrie incluent le nom de la commande, la version de la CLI, le système d'exploitation et l'architecture. Si vous êtes connecté, les événements de télémétrie incluent également l'adresse e-mail de votre compte. L'utilisation sans connexion reste anonyme, et la déconnexion supprime votre adresse e-mail enregistrée. Mintlify ne collecte **pas** de contenu de projet ni de chemins de fichiers.

Par défaut, la CLI collecte les données de télémétrie. Vous pouvez vous désinscrire à tout moment en utilisant le flag `--telemetry` :

Expand Down
6 changes: 3 additions & 3 deletions zh/cli/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Mintlify CLI 命令参考"
sidebarTitle: "命令参考"
description: "Mintlify CLI 所有命令和选项的完整参考，涵盖 mint index、mint dev、mint validate 和 mint broken-links，并说明客户端选择、项目配置、MCP 规则及更多 CLI 工作流，帮助你完成日常文档开发以及部署前检查。"
description: "Mintlify CLI 命令和选项的完整参考，涵盖 mint index、mint dev、mint validate、mint broken-links 等命令。"
keywords: ["CLI", "mint", "命令", "选项", "参考"]
boost: 3
---
Expand All @@ -16,7 +16,7 @@ boost: 3

| 选项 | 描述 |
| --- | --- |
| `--telemetry`, `-t` | 启用或禁用匿名使用遥测。 |
| `--telemetry`, `-t` | 启用或禁用使用遥测。 |
| `--help`, `-h` | 显示命令帮助。 |
| `--version`, `-v` | 显示 CLI 版本。`mint version` 的别名。 |

Expand Down Expand Up @@ -823,7 +823,7 @@ mint version
## 遥测
</div>

CLI 收集匿名使用遥测数据以帮助改进 Mintlify。遥测数据包括命令名称、CLI 版本、操作系统和架构。Mintlify **不会**收集个人身份信息、项目内容或文件路径。
CLI 收集使用遥测数据以帮助改进 Mintlify。遥测数据包括命令名称、CLI 版本、操作系统和架构。如果你已登录，遥测事件还会包含你的账户电子邮件地址。未登录时的使用保持匿名，退出登录会删除已存储的电子邮件。Mintlify **不会**收集项目内容或文件路径。

默认情况下，CLI 会收集遥测数据。你可以随时使用 `--telemetry` 选项退出：

Expand Down