Mintlify CLI

The Mintlify CLI lets you preview documentation locally, test changes in real time, analyze site performance, and run quality checks before deploying to production.

About the CLI

Use the CLI to preview your documentation locally, test changes in real time, analyze site performance, and run quality checks before deploying to production.

The CLI runs on your machine and connects to your Mintlify deployment when you need live data.

Preview locally

Run mint dev to preview your documentation at localhost:3000. As you write and update your content, changes appear in real time without deploying. Log in to enable search and the AI assistant in your local preview.

Analyze your documentation

Run mint analytics to view traffic, search queries, user feedback, and AI assistant conversations directly from the terminal. Useful for quick checks, scripting, and piping data into other tools.

Run quality checks

Run mint broken-links to find broken links, mint a11y to check accessibility, and mint validate to validate your documentation build before it reaches production.

Manage configuration

Run mint config to set persistent defaults like your documentation subdomain and date ranges for analytics commands.

Next steps

• Install the CLI: Get the CLI installed and ready to use.
• Preview locally: Run a local development server with search and assistant support.
• Analyze your documentation: View analytics data from the terminal.
• Commands: Complete reference for all commands and flags.