Skip to main content
Prerequisites:
  • Node.js version 19 or higher
  • This repository cloned locally
1

Install the Mintlify CLI

npm i -g mint
2

Preview locally

Navigate to this repo’s root directory and run:
mint dev
A local preview will be available at http://localhost:3000.

​
Custom ports

mint dev --port 3333

mint broken-links

​
Updating the CLI

npm i -g mint@latest

​
OpenAPI spec

The api-reference/openapi.json file is auto-synced from the Yoshi API via CI after each deploy. To update it manually: 
curl -sf https://api-staging.yoshi.ai/openapi.json -o api-reference/openapi.json

​
Troubleshooting

  1. Remove the CLI: npm remove -g mint
  2. Upgrade to Node v19 or higher
  3. Reinstall: npm i -g mint
Delete ~/.mintlify and run mint dev again.
Last modified on April 14, 2026