Global flags
These flags are available on all commands.
| Flag | Description |
|---|
--telemetry, -t | Enable or disable anonymous usage telemetry. |
--help, -h | Display help for the command. |
--version, -v | Display the CLI version. Alias for mint version. |
mint dev
Start a local preview of your documentation.
| Flag | Description |
|---|
--port | Port to run the local preview on. Defaults to 3000. |
--no-open | Do not open the browser automatically. |
--groups | Comma-separated list of user groups to mock for preview. |
--disable-openapi | Skip OpenAPI file processing to improve performance. |
--local-schema | Allow locally hosted OpenAPI files served over HTTP. |
mint login
Authenticate with your Mintlify account.
Opens a browser window to complete authentication. If the browser does not open, the CLI displays a URL to open manually and a prompt to paste the authorization code. Credentials save in ~/.config/mintlify/config.json.
mint logout
Remove stored credentials.
mint status
Display the account and organization associated with your current session.
mint analytics
View analytics data for your documentation. Requires authentication with mint login.
mint analytics <subcommand> [flags]
Subcommands
| Subcommand | Description |
|---|
stats | Display a summary of views, visitors, searches, feedback, and assistant usage. |
search | Display search queries with hit counts and click-through rates. |
feedback | Display feedback submitted by users. |
conversation list | List assistant conversations. Each entry includes a conversation ID. |
conversation view <conversation-id> | View a single conversation by ID. conversation list returns IDs. |
conversation buckets list | List grouped conversation categories. Each entry includes a bucket ID. |
conversation buckets view <bucket-id> | View conversations in a category bucket. conversation buckets list returns IDs. |
Shared flags
All mint analytics subcommands accept these flags:
| Flag | Description |
|---|
--subdomain | Documentation subdomain. Defaults to the value set with mint config set subdomain. |
--from | Start date in YYYY-MM-DD format. Defaults to 7 days ago, or the value set with mint config set dateFrom. |
--to | End date in YYYY-MM-DD format. Defaults to today, or the value set with mint config set dateTo. |
--format | Output format: plain (default), table, json, or graph. |
--agent | Output JSON. Equivalent to --format json. Also activated automatically when the CLAUDECODE environment variable equals 1. |
stats flags
| Flag | Description |
|---|
--page | Filter to a specific page path. |
--humans | Show only human traffic. |
--agents | Show only AI agent traffic. |
search flags
| Flag | Description |
|---|
--query | Filter by search query substring. |
--page | Filter by top clicked page. |
feedback flags
| Flag | Description |
|---|
--type | Feedback type: page (aggregate by page) or code (code snippet feedback). |
--page | Filter to a specific page path. |
conversation list flags
| Flag | Description |
|---|
--page | Filter conversations that reference a specific page in sources. |
mint config
Manage persistent default values for CLI commands. The configuration saves in ~/.config/mintlify/config.json.
mint config <subcommand> <key> [value]
| Subcommand | Description |
|---|
set <key> <value> | Set a configuration value. |
get <key> | Display a configuration value. |
clear <key> | Remove a configuration value. |
Configuration keys
| Key | Description | Used by |
|---|
subdomain | Default documentation subdomain. | mint analytics |
dateFrom | Default start date for analytics queries (YYYY-MM-DD). | mint analytics |
dateTo | Default end date for analytics queries (YYYY-MM-DD). | mint analytics |
mint broken-links
Check for broken internal links in your documentation.
mint broken-links [flags]
| Flag | Description |
|---|
--check-anchors | Also validate anchor links (for example, /page#section) against heading slugs. |
--check-external | Also check external URLs for broken links. |
--check-snippets | Also check links inside <Snippet> components. |
mint a11y
Check for accessibility issues in your documentation.
Checks color contrast ratios and missing alt text on images and videos.
| Flag | Description |
|---|
--skip-contrast | Skip color contrast checks. |
--skip-alt-text | Skip missing alt text checks. |
mint validate
Validate your documentation build in strict mode. Exits with an error if there are any warnings or errors. Includes automatic validation of OpenAPI specifications referenced in your docs.json.
| Flag | Description |
|---|
--groups | Comma-separated list of user groups to mock for validation. |
--disable-openapi | Skip OpenAPI file processing and validation. |
--local-schema | Allow validation of locally hosted OpenAPI files served over HTTP. Only supports HTTPS in production. |
The standalone mint openapi-check command is deprecated. Use mint validate instead.
mint workflow
Create a workflow file interactively.
The CLI prompts for a name, trigger type, and other settings, then creates a .md file in .mintlify/workflows/.
mint export
Export your documentation as a self-contained zip archive for offline viewing and distribution.
| Flag | Description |
|---|
--output | Output filename. Defaults to export.zip. |
--groups | Comma-separated list of user groups to include restricted pages for. |
--disable-openapi | Skip OpenAPI processing. |
mint new
Create a new documentation project from the Mintlify starter template.
mint new [directory] [flags]
| Flag | Description |
|---|
--name | Project name. The CLI prompts for this if not provided in interactive mode. |
--theme | Project theme. The CLI prompts for this if not provided in interactive mode. |
--force | Overwrite the directory without prompting. |
mint update
Update the CLI to the latest version.
mint upgrade
Convert a mint.json configuration file to the current docs.json format.
See Global settings for more information.
mint version
Display the current CLI and client versions.
Coming soon
These commands are available to run but are not yet functional. Running them records your interest through CLI telemetry and helps prioritize what ships next.
| Command | Description |
|---|
mint ai | AI-powered documentation tools. |
mint test | Documentation testing. |
mint signup | Account sign-up from the CLI. |
mint mcp | MCP server for documentation. |
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 using the --telemetry flag:
# Disable telemetry
mint --telemetry false
# Re-enable telemetry
mint --telemetry true
| Variable | Value | Description |
|---|
MINTLIFY_TELEMETRY_DISABLED | 1 | Disable Mintlify CLI telemetry. |
DO_NOT_TRACK | 1 | Disable telemetry using the Console Do Not Track standard. |
~/.config/mintlify/config.json and persists across CLI sessions.
