{"id":18562,"library":"mintlify","title":"Mintlify CLI","description":"Command-line interface for building and previewing Mintlify documentation sites. v4.2.531 requires Node >=18 (20.17+ recommended, Node 25+ unsupported). Released ~weekly by Mintlify. Differentiates from other doc tools via cloud-hosted platform with built-in analytics, search, and design; the CLI provides local preview, validation, broken link checking, accessibility checks, and OpenAPI validation.","status":"active","version":"4.2.531","language":"javascript","source_language":"en","source_url":"https://github.com/mintlify/mint","tags":["javascript","mintlify","mint","cli"],"install":[{"cmd":"npm install mintlify","lang":"bash","label":"npm"},{"cmd":"yarn add mintlify","lang":"bash","label":"yarn"},{"cmd":"pnpm add mintlify","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[],"quickstart":{"code":"npm i -g mintlify\ncd /path/to/mintlify-project\nmintlify dev --port 3333\n# Opens http://localhost:3333 in browser\nmintlify validate\nmintlify broken-links --check-external --check-anchors\nmintlify openapi-check ./openapi.yaml","lang":"javascript","description":"Install globally, start a local dev server on port 3333, validate docs, and run various checks."},"warnings":[{"fix":"Use Node 20.17 or 22.x LTS. Avoid Node 25+.","message":"Requires Node 20.17 or higher. Node 25+ is not supported.","severity":"breaking","affected_versions":">=4.2.531"},{"fix":"Ensure you run the command in a Mintlify project root that contains a docs.json file.","message":"Running in a folder without a docs.json file will cause 'mintlify dev' to fail.","severity":"gotcha","affected_versions":">=0"},{"fix":"Use --port to specify a free port explicitly, or check which port the server actually started on.","message":"If the specified port is already in use, the CLI automatically tries the next available port, which may be unexpected.","severity":"gotcha","affected_versions":">=0"},{"fix":"Use 'mintlify dev' for local preview.","message":"The old 'mintlify scripts' command is deprecated in favor of 'mintlify dev' or other subcommands.","severity":"deprecated","affected_versions":">=4.0"},{"fix":"Run 'mintlify update' or reinstall with 'npm i -g mintlify@latest'.","message":"After updating Mintlify CLI, you may need to run 'mintlify update' to get the latest version; the installed global version may not auto-update.","severity":"gotcha","affected_versions":">=0"},{"fix":"Check the exact casing of user groups in your project configuration.","message":"The '--groups' flag for mock user groups is case-sensitive and must match exactly the group names in your docs.json.","severity":"breaking","affected_versions":">=4.0"}],"env_vars":null,"last_verified":"2026-04-25T00:00:00.000Z","next_check":"2026-07-24T00:00:00.000Z","problems":[{"fix":"Change to the correct project root that contains docs.json.","cause":"'mintlify dev' executed in a directory without a Mintlify project.","error":"Error: Must be run in a folder with a docs.json file."},{"fix":"Use 'mintlify dev --port <available-port>' to specify a free port.","cause":"Default port 3000 occupied by another process.","error":"Error: The port 3000 is already in use. Trying next port."},{"fix":"Install Node 20.17 or 22.x LTS via nvm or your system package manager.","cause":"Running Node 25+ which is not supported by Mintlify CLI v4.2.531.","error":"Error: Node.js version 25.x is not supported. Please use Node 20.17 or higher, but not 25+."},{"fix":"Provide an absolute or correct relative path to the OpenAPI spec file.","cause":"The file path provided to 'mintlify openapi-check' does not exist or is incorrect.","error":"Error: openapi-check: Cannot find module '/path/to/openapi.yaml'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}