CLI installation

Use the CLI to preview and maintain your documentation locally

Use the CLI to preview your documentation locally as you write and edit.

Install the CLI

Prerequisite: The CLI requires Node.js v19 or higher.

npm

npm i -g mint

Preview locally

Navigate to your documentation directory and run:

mint dev

Your documentation is available at http://localhost:3000.

Custom ports

Use the --port flag to customize the port:

mint dev --port 3333

Preview as a specific group

If you use partial authentication, preview as a specific group:

mint dev --groups admin

Additional commands

Update the CLI

mint update

Find broken links

mint broken-links

Find accessibility issues

mint a11y

Check OpenAPI spec

mint openapi-check <OpenAPI filename or URL>

Rename files

mint rename <path/to/old-filename> <path/to/new-filename>

Troubleshooting

Error: Could not load the "sharp" module using the darwin-arm64 runtime

1. Remove the CLI: npm uninstall -g mint
2. Upgrade to Node.js v19+
3. Reinstall: npm install -g mint

Issue: Encountering an unknown error

Delete the ~/.mintlify folder and run mint dev again.

Error: permission denied

Run sudo npm i -g mint and enter your password.

The local preview doesn't look the same as my docs do on the web

Run mint update to get the latest changes.