Skip to content

(test pr) Mintlify CLI overview and commands #6729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −5
Open

(test pr) Mintlify CLI overview and commands #6729

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions cli/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ 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"
className="block my-0 pointer-events-none dark:hidden"
alt="Decorative graphic representing the CLI."
src="/images/installation/local-development-light.png"
/>
<img
className="hidden dark:block my-0 pointer-events-none"
src="/images/installation/local-development-dark.png"
className="my-0 pointer-events-none hidden dark:block"
alt="Decorative graphic representing the CLI."
src="/images/installation/local-development-dark.png"
/>

## About the CLI
Expand All @@ -23,22 +23,32 @@ Use the [CLI](https://www.npmjs.com/package/mint) to preview your documentation

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

### Make an account

Run `mint signup` to signup for a new mintlify account

### 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>
Expand All @@ -51,4 +61,4 @@ Run `mint config` to set persistent defaults like your documentation subdomain.

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