Skip to main content
Decorative graphic representing the CLI. Preview your documentation locally, test changes in real-time, and use utilities to maintain your docs.

​
Install

Prerequisite: Requires Node.js v20.17.0 or higher (LTS preferred).
npm i -g mint

​
Preview locally

Navigate to your documentation directory and run: 
mint dev
Your docs will be available at http://localhost:3000. Use npx mint dev to run without global installation. Custom port: Use --port to specify a different port: 
mint dev --port 3333
Preview as a group: Use --groups to preview with specific authentication permissions: 
mint dev --groups admin

​
Create a new project

mint new [directory]
This clones the starter kit and prompts you for a project name and theme. Flags:
  • --theme: Set the theme
  • --name: Set the project name
  • --force: Overwrite existing directory
mint new docs --name my-project --theme linden

​
Update

mint update
If mint update is unavailable, reinstall: 
npm i -g mint@latest

​
Commands

Find broken links: 
mint broken-links
Check accessibility: 
mint a11y
Validate OpenAPI spec: 
mint openapi-check <filename or URL>
Rename files: 
mint rename <old-path> <new-path>
Migrate MDX endpoints: 
mint migrate-mdx
See Migrating from MDX for details.

​
IDE setup

VS Code / Cursor / Windsurf: Install MDX extension and Prettier. JetBrains: Install MDX plugin and Prettier.

​
Troubleshooting

Upgrade Node.js, then reinstall:
npm uninstall -g mint && npm install -g mint
Delete ~/.mintlify folder and run mint dev again.
Run with sudo:
sudo npm i -g mint
Update the CLI:
mint update
If you have both packages installed, uninstall the old one:
npm uninstall -g mintlify
npm cache clean --force
npm i -g mint