Skip to main content
Prerequisite You should have installed Node.js (version 18.10.0 or higher).
Step 1. Install the CLI: 
npm i -g mintlify
Step 2. From apps/docs, run the local server: 
mintlify dev --port 3004
The documentation website is now available at http://localhost:3004.

​
Custom Ports

Mintlify uses port 3000 by default. We run on 3004 to avoid conflicts. You can customize with --port: 
mintlify dev --port 3333
You will see an error like this if you try to run Mintlify in a port that’s already taken: 
Error: listen EADDRINUSE: address already in use :::3000

​
Keep the CLI updated

Update the CLI if local output diverges from production: 
npm i -g mintlify@latest

​
Deployment

You should see the following if the deploy successfully went through:

​
Troubleshooting

Here’s how to solve some common problems when working with the CLI.
Use Node v18+. Reinstall the CLI and try again.
Go to the C:/Users/Username/.mintlify/ directory and remove the mint folder. Then Open the Git Bash in this location and run git clone https://github.com/mintlify/mint.git.Repeat step 3.
Try navigating to the root of your device and delete the ~/.mintlify folder. Then run mintlify dev again.