{"library":"mint","title":"Mintlify CLI","description":"The `mint` package provides the official Command Line Interface (CLI) for Mintlify, a platform for building and publishing documentation. It enables developers to scaffold new documentation sites, preview changes locally, validate documentation builds in strict mode (useful for CI/CD), check for broken internal and external links, validate OpenAPI specifications, and perform accessibility audits. The current stable version is 4.2.527. As a CLI tool, its release cadence is typically tied to the evolution of the Mintlify platform itself, receiving regular updates to support new features and address issues. Key differentiators include its tight integration with the Mintlify ecosystem, specialized commands for documentation validation (e.g., `broken-links`, `openapi-check`, `a11y`), and a streamlined local development workflow with `mint dev`. It is designed for direct command-line execution rather than programmatic import.","language":"javascript","status":"active","last_verified":"Thu Apr 23","install":{"commands":["npm install mint"],"cli":{"name":"mint","version":null}},"imports":["Install globally via npm: `npm i -g mint`. Then use from command line: `mint <command>`","Interact with Mintlify projects via CLI commands like `mint dev` or `mint validate`.","Execute specific commands directly in the terminal: `mint dev`, `mint validate`, `mint broken-links`, etc."],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"{\n// 1. Install the Mintlify CLI globally\n// npm i -g mint\n\n// 2. Navigate to your desired project directory (or create a new one)\n// cd my-new-docs\n\n// 3. Initialize a new Mintlify documentation site\n// mint new\n\n// 4. Start the local development server to preview your documentation\n// This command will open your documentation in a browser at http://localhost:3000 by default.\n// Use --port <number> to specify a different port or --no-open to prevent automatic browser opening.\n// mint dev --port 3333\n\n// 5. To validate your documentation for CI/CD, run:\n// mint validate\n\n// 6. To check for broken internal links:\n// mint broken-links --check-external --check-anchors\n}","lang":"typescript","description":"Demonstrates how to install the Mintlify CLI globally, initialize a new documentation project, run a local development preview server on a custom port, and perform basic documentation validation and link checking.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}