Skip to content

Add CLI telemetry documentation#5039

Merged
ethanpalm merged 2 commits intomainfrom
mintlify/cli-telemetry-docs-1775003330
Apr 5, 2026
Merged

Add CLI telemetry documentation#5039
ethanpalm merged 2 commits intomainfrom
mintlify/cli-telemetry-docs-1775003330

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify bot commented Apr 1, 2026

Summary

  • Documents the new anonymous usage telemetry in the Mintlify CLI, which collects command names, CLI version, OS, and architecture to help improve the product.
  • Explains how to opt out using mint --telemetry false or environment variables (MINTLIFY_TELEMETRY_DISABLED, DO_NOT_TRACK).

Triggered by: CLI telemetry feature shipped in mintlify/mint#6790.


Note

Low Risk
Documentation-only change describing anonymous CLI telemetry and how to disable it; no product code or data-handling logic is modified.

Overview
Adds a new Telemetry section to installation.mdx documenting the Mintlify CLI’s anonymous usage telemetry (what is collected and what is explicitly not collected).

Documents opt-out/opt-in controls via the --telemetry flag, supported environment variables (MINTLIFY_TELEMETRY_DISABLED, DO_NOT_TRACK), and notes that the preference is persisted in ~/.config/mintlify/config.json.

Reviewed by Cursor Bugbot for commit 6687b84. Bugbot is set up for automated code reviews on this repo. Configure here.

Generated-By: mintlify-agent
@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify bot commented Apr 1, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 1, 2026, 12:33 AM

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
@ethanpalm ethanpalm merged commit 44d11ab into main Apr 5, 2026
5 checks passed
@ethanpalm ethanpalm deleted the mintlify/cli-telemetry-docs-1775003330 branch April 5, 2026 01:26
ethanpalm added a commit that referenced this pull request Apr 6, 2026
Incorporates telemetry content from #5039 which was merged to main after
this branch was created. Documents opt-out flags, env variables, and
config persistence.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
ethanpalm added a commit that referenced this pull request Apr 6, 2026
* update skills

* update migration guide

* update API migration guide

* update assistant page

* update analytics page

* update CLI commands

* deprecate openapi-check

* add coming soon

* update docs.json

* add index page

* add install page

* add preview page

* add analytics

* add commands reference

* update links

* delete installation.mdx

* add optional prereq steps

* Add telemetry section to commands reference

Incorporates telemetry content from #5039 which was merged to main after
this branch was created. Documents opt-out flags, env variables, and
config persistence.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* move global flags to top

* vale

* remove `mint upgrade`

* remove unnecessary prereq

* restructure analytics commands

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant