Skip to main content
Prerequisite You should have installed Node.js (version 18.10.0 or higher).
Step 1. Install Mintlify on your OS:
Step 2. Go to the docs app (apps/docs, where docs.json lives) and run the following command:
The documentation website is now available at http://localhost:3000.

​
Custom Ports

Mintlify uses port 3000 by default. You can use the --port flag to customize the port Mintlify runs on. For example, use this command to run in port 3333:
You will see an error like this if you try to run Mintlify in a port that’s already taken:

​
Mintlify Versions

Each CLI is linked to a specific version of Mintlify. Please update the CLI if your local website looks different than production.

​
Deployment

Unlimited editors available under the Startup Plan
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.
Update to Node v18. Run mintlify install 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.
Curious about what changed in a CLI version? Check out the CLI changelog.