# Mintlify CLI (/cli)

<!-- agent-signals: reading_time_min: 2 · est_tokens: 780 · updated: 2026-07-30 -->
Related: [What is the agent?](/agent.md), [Assistant](/assistant.md), [Automations overview](/automations.md), [Components overview](/components.md), [Editor overview](/editor.md), [Guides](/guides.md)

<img className="block dark:hidden my-0 pointer-events-none" src="/_assets/de78fe0f3bf7d6830af6f0d44c72833fb5eff742fc665c0bdf878c3bc151a926" alt="Decorative graphic representing the CLI." />

<img className="hidden dark:block my-0 pointer-events-none" src="/_assets/2081bbc3b44cbe8fc8f261d95d703a995912b4bf17798e4441d85538c3de6095" alt="Decorative graphic representing the CLI." />

## About the CLI [#about-the-cli]

Use the [CLI](https://www.npmjs.com/package/mint) to preview your documentation locally, test changes in real time, 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 [#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.

### Run quality checks [#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 [#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.

### Detect AI-sounding prose [#detect-ai-sounding-prose]

Run `mint deslop` to check pages for AI-generated prose and get human-style rewrite suggestions. With no arguments, the command checks the pages you have changed. It flags the specific passages that read as AI-generated so you can revise them.

### Format MDX files [#format-mdx-files]

Run `mint format` to rewrite the MDX files in your project to Mintlify's canonical style. The command walks every subdirectory and reformats files in place.

### Manage configuration [#manage-configuration]

Run `mint config` to set persistent defaults like your documentation subdomain.

<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="[&#x22;copy&#x22;, &#x22;cursor&#x22;]">
  Install the Mintlify skill for context on project structure, components, and documentation best practices:

  npx skills add https\://mintlify.com/docs

  Add the Mintlify Docs MCP server for documentation search:

  https\://mintlify.com/docs/mcp

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

  https\://mcp.mintlify.com
</Prompt>

## Next steps [#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.
* [Commands](/cli/commands): Complete reference for all commands and flags.