Démarrer une prévisualisation locale de votre documentation.
Créez un nouveau compte Mintlify depuis un terminal interactif.
Exécutez la commande sans flags pour saisir vos informations de manière interactive. La CLI vous demandera toute valeur que vous ne passez pas comme flag.
Après avoir soumis vos informations, Mintlify envoie un lien de vérification à votre adresse e-mail. La commande attend jusqu’à ce que vous cliquiez sur le lien, puis crée votre compte, vous connecte et enregistre vos identifiants. Une fois terminé, ouvrez le tableau de bord pour connecter votre dépôt et commencer à construire.
mint signup ne se termine pas tant que vous n’avez pas cliqué sur le lien de vérification, ce qui peut prendre plusieurs minutes.Lorsqu’un agent IA exécute mint signup, ou que la commande s’exécute sans terminal interactif, elle affiche le guide d’inscription pour les agents au lieu de créer un compte. Les agents créent des sites sans compte grâce à l’inscription par un agent.Créez un site sans compte et obtenez un accès en push Git à ce site. Pour le processus complet, consultez Inscription par un agent.
Exécutez à nouveau la commande depuis le même répertoire pour obtenir un nouveau jeton d’écriture pour le même site. Dans GitHub Actions,
mint deploy pousse le commit extrait vers un site qui fait confiance au dépôt. Le workflow nécessite la permission id-token: write.
Revendiquer un site créé avec
mint deploy.
Exécutez
mint claim pour obtenir un lien de revendication. Le propriétaire du site l’ouvre, se connecte avec n’importe quel compte et clique sur Confirm ; le site est déplacé dans une nouvelle organisation de son compte. --email et --code ne peuvent pas être combinés.
S’authentifier avec votre compte Mintlify.
mint config set subdomain <subdomain>.
Supprimer les identifiants stockés.
Afficher les détails de votre session actuelle, y compris la version de la CLI, l’adresse e-mail du compte, l’organisation et le sous-domaine configuré.
Ajoutez un domaine personnalisé à votre projet depuis le terminal. Nécessite une authentification avec
mint login.
La commande utilise le sous-domaine configuré via
mint config. Si aucun n’est défini, elle utilise le premier sous-domaine de votre compte.
Une fois le domaine enregistré, la CLI attend jusqu’à 10 secondes que les enregistrements DNS soient générés, puis affiche les enregistrements TXT et CNAME à ajouter chez votre fournisseur de domaine :
TXT, puis ajoutez le CNAME une fois les enregistrements de vérification validés. Consultez Domaine personnalisé pour les instructions complètes de configuration DNS, les exigences pour les domaines apex et les détails sur le provisionnement TLS.
Si la commande échoue avec Domain is already in use by another deployment in your organization ou Domain is already claimed by another organization, le domaine est lié à un autre projet Mintlify. Consultez L’ajout d’un domaine échoue avec “Domain is already claimed by another organization” pour le libérer et le rajouter.
Si certains enregistrements
TXT sont encore en cours de génération à la fin de la commande, consultez la page Configuration du domaine personnalisé dans votre Dashboard pour récupérer les valeurs restantes.--basePath, la CLI enregistre le base path après avoir enregistré le domaine. Le nouveau chemin s’applique lors de votre prochain déploiement, et votre site continue d’être servi depuis le chemin actuel jusque-là. Le CNAME envoie tout le trafic du domaine vers Mintlify, donc ne l’ajoutez que si le domaine n’héberge rien d’autre. Sinon, conservez votre DNS actuel et configurez un reverse proxy vers Mintlify pour le base path. Consultez Héberger la documentation sur un sous-chemin pour des guides par fournisseur.
Ajoutez un domaine personnalisé à la racine :
/docs :
Interrogez les analytics de la documentation depuis le terminal. Nécessite une authentification avec
mint login.
Les analytics nécessitent un plan Pro ou Enterprise.
Affiche les KPI principaux pour une plage de dates : vues, visiteurs, recherches, retours et utilisation de l’assistant. Le trafic humain et le trafic des agents sont rapportés séparément.
Affiche les requêtes de recherche avec le nombre de résultats, les taux de clics, la page la plus cliquée et la date de la dernière recherche.
Affiche les retours soumis par les utilisateurs. Par défaut, renvoie les entrées de retour individuelles. Passez
--type page pour voir les retours agrégés par chemin de page, ou --type code pour n’inclure que les retours sur les extraits de code.
Consultez les analytics des conversations de l’assistant.
Liste les conversations récentes de l’assistant avec l’horodatage, la première requête utilisateur et la catégorie.
Affiche le fil de messages complet pour une seule conversation.
Liste les clusters de conversations regroupées par sujet, avec le nombre de conversations et la date de la question la plus récente pour chaque cluster.
Configurer des agents de codage IA pour travailler sur votre projet Mintlify. La commande installe les compétences Mintlify et configure l’Admin MCP pour Claude Code, Codex ou Cursor.
mint agent setup nécessite Node.js 22.20 ou une version ultérieure ainsi que npm. La CLI ne fonctionne pas sous Node.js 25.--agent.
La commande ajoute un serveur MCP nommé mintlify avec l’URL https://mcp.mintlify.com au fichier de configuration de chaque agent.
Si votre configuration Codex définit
mcp_servers comme une table inline, la configuration ne peut pas y ajouter d’entrée et s’arrête avec une erreur. Ajoutez vous-même une entrée mintlify avec url = "https://mcp.mintlify.com" à la table inline.
Si CLAUDE_CONFIG_DIR est défini, la configuration --global pour Claude Code s’arrête avec une erreur. Ajoutez plutôt le serveur avec la CLI Claude Code :
mintlify correspondante. Si une entrée mintlify a une configuration différente, ou si un fichier de configuration ne peut pas être analysé, la configuration s’arrête avant d’installer les compétences. Renommez ou supprimez l’entrée en conflit, puis exécutez à nouveau la commande.
La configuration recherche uniquement une entrée nommée mintlify. Si un agent se connecte déjà à l’Admin MCP sous un autre nom, comme mintlify-admin, la configuration ajoute une seconde entrée. Supprimez l’une d’elles pour que l’agent ne se connecte pas deux fois à l’Admin MCP.
Relancer la commande actualise les compétences installées et remplace toutes les modifications locales que vous y avez apportées.
La commande ne vous connecte pas à l’Admin MCP et ne réutilise pas vos identifiants mint login. Après la configuration, effectuez la connexion OAuth dans chaque agent. La commande affiche les étapes pour chaque agent que vous avez configuré.
Affiche des instructions étape par étape pour une tâche dans Mintlify, rédigées pour les agents de codage IA. Chaque sujet couvre une tâche courante, comme publier un nouveau site ou ajouter un domaine personnalisé. Il liste les étapes, les règles que les agents appliquent souvent mal et la manière de vérifier le résultat. Votre agent peut exécuter la commande avant de commencer une tâche au lieu de s’appuyer sur ses données d’entraînement. La CLI récupère chaque sujet depuis la documentation Mintlify en ligne, de sorte que les instructions restent à jour sans mise à jour de la CLI.
overview.
La commande nécessite une connexion Internet. Si un sujet n’existe pas, la commande se termine avec une erreur. Exécutez
mint instructions pour voir les sujets valides.
Si votre CLI installée ne reconnaît pas la commande, exécutez mint update ou utilisez npx mint@latest instructions.
Gérer les valeurs par défaut persistantes pour les commandes de la CLI. La configuration est enregistrée dans
~/.config/mintlify/config.json.
Vérifier les liens internes cassés dans votre documentation.
.mdx et .md et exclut les fichiers correspondant aux motifs .mintignore. Les liens contenus dans les fichiers de spécification OpenAPI (.yaml, .yml, .json) ne sont pas vérifiés. Les liens pointant vers des fichiers ignorés sont signalés comme cassés.
La commande vérifie les liens et images Markdown, y compris les liens de style référence comme [text][id]. Elle vérifie aussi le href des composants <a> et <Card> ainsi que le src des balises <img> et <source>, qu’ils soient écrits sous forme de chaîne simple ou de valeur fixe entre accolades, comme href={"/quickstart"}. Les valeurs calculées à partir de variables ne sont pas vérifiées.
Les liens sans / initial, comme quickstart ou ../quickstart, sont résolus à partir du répertoire de la page qui les contient, de la même manière qu’un navigateur les résout. Pour créer un lien depuis la racine de votre site, commencez le chemin par /.
Les liens relatifs à la racine qui conservent l’extension .mdx, comme /quickstart.mdx, sont signalés comme cassés, car Mintlify sert les pages sans l’extension. Supprimez l’extension ou ajoutez une redirection du chemin .mdx vers la page. Les liens relatifs comme ./quickstart.mdx dans les liens Markdown et les valeurs href fonctionnent, car Mintlify supprime l’extension, mais les définitions de liens de style référence comme [id]: ./quickstart.mdx la conservent et sont signalées comme cassées.
Pour les liens sans / initial et les liens d’ancre (#) à l’intérieur d’un snippet, la commande vérifie chaque page qui affiche le snippet. La commande signale un de ces liens uniquement s’il est cassé sur au moins une de ces pages. Avec --check-anchors, les titres à l’intérieur d’un snippet comptent comme des ancres sur les pages qui l’affichent.
Utilisez
--files pour limiter la vérification à des pages spécifiques. C’est utile pour valider une seule page que vous venez de modifier ou pour restreindre les vérifications à un répertoire en CI. Lorsque --files est combiné avec --check-external, seules les URLs externes des pages sélectionnées sont vérifiées.
Vérifier les problèmes d’accessibilité dans votre documentation.
Vérifier votre documentation à la recherche d’erreurs, puis valider la compilation en mode strict. Inclut la validation automatique des spécifications OpenAPI référencées dans votre
docs.json.
mint validate exécute un ensemble de règles sur vos pages, snippets, navigation et spécifications OpenAPI, puis lance une compilation stricte. Les résultats s’affichent regroupés par fichier, avec la ligne, la colonne et le nom de la règle pour chacun lorsqu’ils sont disponibles.
Les règles duplicate-h1, katex, foreign-syntax et url-collision signalent des avertissements : leurs résultats ne font donc pas échouer l’exécution. Les autres règles signalent des erreurs.
La compilation stricte ne s’exécute que si aucune règle ne signale d’erreur et qu’au moins une règle sélectionnée a besoin de la compilation. Si une règle signale une erreur, la commande ignore la compilation et vous demande de corriger d’abord les erreurs. Les avertissements que la compilation ne peut pas attribuer à une règle font échouer l’exécution en tant qu’erreurs build-failed.
Avec
--fix, mint validate effectue jusqu’à cinq passes de correction, car une correction peut en débloquer une autre. Par exemple, fermer automatiquement un <br> peut permettre l’analyse d’une page. Après la dernière passe, toutes les règles s’exécutent une fois de plus et le rapport montre ce qui reste. La sortie liste chaque correction appliquée sous la forme fixed <file>:<line> <rule>: "before" → "after".
--fix ignore une correction qui chevauche une autre correction dans le même fichier. Il laisse également un fichier Markdown ou MDX inchangé si le contenu corrigé s’analyserait moins bien qu’auparavant. Sans --fix, la sortie se termine par le nombre de problèmes que --fix corrigerait.
Avec --format json, la sortie de progression est masquée et le reste de la sortie console est envoyé sur stderr, ce qui vous permet d’analyser directement stdout. Le rapport contient les champs suivants :
passed:truelorsqu’aucune règle n’a signalé d’erreur.summary: le nombre d’errorset dewarnings, ainsi quebyRuleavec un décompte pour chaque ID de règle.diagnostics: chaque résultat, avecrule,group,severity(errorouwarning),file,lineetcolumnfacultatifs,messageet unfixfacultatif.build:{ "ran": true, "passed": <boolean> }si la compilation stricte s’est exécutée, sinon{ "ran": false, "reason": <reason> }avec un motif parmidisabled,errors foundouno build rules.fixed: uniquement avec--fix. Chaque modification appliquée, avecrule,file,lineetcolumnfacultatifs,beforeetafter.
mint validate ne peut pas s’exécuter, la commande n’affiche rien sur stdout et écrit Error: <message> sur stderr.
La commande se termine avec l’un des codes suivants :
0: aucune règle n’a signalé d’erreur. Les avertissements ne font pas échouer l’exécution.1: au moins une règle a signalé une erreur.2:mint validaten’a pas pu s’exécuter, par exemple à cause d’un nom de règle inconnu, d’une valeur--filesqui ne correspond à aucune page ni aucun snippet, ou d’un plantage.
Utilisez
mint validate à la place de la commande autonome mint openapi-check, qui est obsolète.Génère l’image d’aperçu pour les réseaux sociaux (OG) d’une page dans un fichier PNG. La commande utilise les paramètres
thumbnails de votre docs.json, les remplacements thumbnail des pages et des sections, et le même code de rendu que votre site en ligne.
La commande affiche des avertissements lorsque le titre est trop long pour tenir sur deux lignes, lorsqu’aucun logo n’est configuré ou que le logo ne se charge pas, lorsque la police ne se charge pas et lorsque le texte manque de contraste sur une surface
brand. Les avertissements ne modifient pas le code de sortie. La commande se termine avec le code 1 si docs.json n’est pas valide ou si la page n’existe pas.
Exporter votre documentation sous forme d’archive zip autonome pour la consultation et la distribution hors ligne.
Consultez Export hors ligne pour plus de détails.
Exécuter des vérifications de préparation pour les agents sur un site de documentation public. Nécessite une authentification avec
mint login.
La commande affiche un score global de préparation et un détail des vérifications individuelles avec des indicateurs de réussite/échec.
Certaines vérifications ne s’exécutent que si une vérification dont elles dépendent réussit. Si une vérification échoue, aucune des vérifications qui en dépendent ne s’exécute. Elles échouent automatiquement. Par exemple,
llmsTxtValid ne réussit que si llmsTxtExists réussit d’abord.
Le score global utilise une notation pondérée, de sorte que les vérifications à plus fort impact contribuent davantage à votre score.
Formate chaque fichier
.mdx du répertoire courant selon le style canonique de Mintlify. La commande analyse chaque fichier avec le même parseur MDX que celui utilisé par l’éditeur web, puis le réécrit sur place si la sortie canonique diffère.
.gitignore et à toute règle d’exclusion Mintlify. Les fichiers qui correspondent déjà à la sortie canonique restent inchangés.
Une fois terminé, la commande affiche le nombre de fichiers MDX reformatés et le nombre de fichiers dont l’analyse a échoué. Si un fichier échoue, la commande se termine avec le code 1 et affiche le chemin du fichier ainsi que l’erreur, ce qui vous permet de l’exécuter en CI pour imposer un formatage cohérent. Consultez Installer en CI pour un exemple de pipeline.
Affichez des instructions détaillées pour migrer un site de documentation existant vers Mintlify, ou transmettez ces instructions à un agent d’IA pour qu’il effectue la migration.
Sans flag, la commande affiche une vue d’ensemble du workflow de migration, suivie des sujets et des plateformes sources disponibles. Les instructions sont rédigées pour les agents de programmation : vous pouvez donc les coller dans votre agent ou laisser votre agent exécuter
mint migrate lui-même.
Avec --agent, la CLI lance l’outil en ligne de commande de l’agent spécifié avec un prompt lui demandant d’exécuter mint migrate et de suivre les instructions affichées. La CLI de l’agent doit déjà être installée. Si la CLI Mintlify ne trouve pas la CLI de l’agent, mint migrate se termine avec une erreur qui inclut la commande d’installation.
Créer un nouveau projet de documentation en choisissant un thème ou en clonant un modèle prédéfini depuis le dépôt mintlify/templates.
Mettre à jour la CLI et le client de prévisualisation local vers les dernières versions.
Afficher les versions actuelles de la CLI et du client.
Envoyer des commentaires à l’équipe Mintlify. Vous n’avez pas besoin de vous connecter. N’incluez jamais de clés d’API, de jetons, de mots de passe ou d’autres secrets dans le message.
Ces commandes sont disponibles mais ne sont pas encore fonctionnelles. Les exécuter enregistre votre intérêt via la télémétrie de la CLI et aide à prioriser les prochaines fonctionnalités.
La CLI collecte des données de télémétrie d’utilisation pour aider à améliorer Mintlify. Les données de télémétrie incluent le nom de la commande, la version de la CLI, le système d’exploitation, l’architecture et la version de Node.js. Elles indiquent également si la CLI s’exécute dans un environnement de CI, si elle s’exécute dans un terminal interactif, s’il s’agit de la première exécution de la CLI sur votre machine et si vous êtes connecté. Si la CLI détecte qu’un agent de codage IA l’exécute, la télémétrie inclut également le nom de cet agent. Chaque événement inclut également un identifiant de session qui regroupe les événements d’une même session de travail. La CLI le stocke dans
~/.config/mintlify/telemetry-session.json et le remplace après 30 minutes d’inactivité. Si vous êtes connecté, les événements de télémétrie incluent également l’adresse e-mail de votre compte. L’utilisation sans connexion reste anonyme, et la déconnexion supprime votre adresse e-mail enregistrée. Mintlify ne collecte pas de contenu de projet ni de chemins de fichiers.
Par défaut, la CLI collecte les données de télémétrie. Vous pouvez vous désinscrire à tout moment en utilisant le flag --telemetry :
Votre préférence est enregistrée dans
~/.config/mintlify/config.json et persiste entre les sessions de la CLI.