> ## Documentation Index
> Fetch the complete documentation index at: https://www.mintlify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Mintlify CLI

> Use the Mintlify CLI to preview docs locally, test changes in real time, analyze site performance, and run quality checks before deploying.

<img className="block dark:hidden my-0 pointer-events-none" src="https://mintcdn.com/mintlify/Y6rP0BmbzgwHuEoU/images/installation/local-development-light.png?fit=max&auto=format&n=Y6rP0BmbzgwHuEoU&q=85&s=ffd8bc88d87fc00fe1919a33a292fa01" alt="Decorative graphic representing the CLI." width="1184" height="320" data-path="images/installation/local-development-light.png" />

<img className="hidden dark:block my-0 pointer-events-none" src="https://mintcdn.com/mintlify/Y6rP0BmbzgwHuEoU/images/installation/local-development-dark.png?fit=max&auto=format&n=Y6rP0BmbzgwHuEoU&q=85&s=ef0bb527eb258f8d720180d106ea6625" alt="Decorative graphic representing the CLI." width="1184" height="320" data-path="images/installation/local-development-dark.png" />

## About the CLI

Use the [CLI](https://www.npmjs.com/package/mint) 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.

### Check agent readiness

Run `mint score` to evaluate how well agents can navigate a documentation site. With no arguments, the command scores your configured subdomain. Pass a URL to score any other site. The command displays an overall readiness score and individual check results.

### Manage configuration

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

<Tip>
  Working on your docs locally with an AI coding tool? Install the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) so your editor has the context it needs to write Mintlify-aware content.
</Tip>

<Prompt description="Install the Mintlify skill and MCP servers for AI coding tools." actions={["copy", "cursor"]}>
  Install the Mintlify skill for context on project structure, components, and documentation best practices:

  npx skills add [https://mintlify.com/docs](https://mintlify.com/docs)

  Add the Mintlify Docs MCP server for documentation search:

  [https://mintlify.com/docs/mcp](https://mintlify.com/docs/mcp)

  Add the Mintlify MCP server for dashboard access and content management:

  [https://mcp.mintlify.com](https://mcp.mintlify.com)
</Prompt>

## Next steps

* [Install the CLI](/cli/install): Get the CLI installed and ready to use.
* [Preview locally](/cli/preview): Run a local development server with search and assistant support.
* [Analyze your documentation](/cli/analytics): View analytics data from the terminal.
* [Commands](/cli/commands): Complete reference for all commands and flags.


## Related topics

- [Commands](/docs/cli/commands.md)
- [How to link documentation pages effectively](/docs/guides/linking.md)
- [What is the agent?](/docs/agent/index.md)