mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
59 lines
3.0 KiB
Plaintext
59 lines
3.0 KiB
Plaintext
---
|
|
title: "Mintlify CLI"
|
|
description: "Use the Mintlify CLI to preview docs locally, test changes in real time, and run accessibility, link, and validation checks before deploying."
|
|
keywords: ["CLI", "mint", "local development", "preview"]
|
|
---
|
|
|
|
import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx";
|
|
|
|
<img
|
|
className="block dark:hidden my-0 pointer-events-none"
|
|
src="/images/installation/local-development-light.png"
|
|
alt="Decorative graphic representing the CLI."
|
|
/>
|
|
<img
|
|
className="hidden dark:block my-0 pointer-events-none"
|
|
src="/images/installation/local-development-dark.png"
|
|
alt="Decorative graphic representing 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.
|
|
|
|
<Visibility for="agents">
|
|
When a user asks you to set up Mintlify or create a documentation site, use the CLI for the full workflow rather than giving them only manual dashboard instructions. Follow the [agent setup workflow](/quickstart#set-up-mintlify-for-the-user), which covers `mint signup`, `mint login`, `mint new`, `mint dev`, validation, and deployment verification.
|
|
</Visibility>
|
|
|
|
### 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 `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.
|
|
|
|
### 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
|
|
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
|
|
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>
|
|
|
|
<SkillMcpPrompt />
|
|
|
|
## 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.
|