Passer au contenu principal
Pour installer la CLI, consultez Installer la CLI.

Flags globaux

Ces flags sont disponibles pour toutes les commandes.

mint dev

Démarrer une prévisualisation locale de votre documentation.

mint index

Installez le serveur MCP Index hébergé de Mintlify pour vos agents de codage. Le serveur fournit un outil context pour rechercher des bibliothèques, frameworks, SDK, API et outils CLI. Le serveur MCP Index est distinct du serveur MCP Mintlify Docs, qui effectue des recherches dans votre site de documentation.

Options

Sélectionner les clients

Exécutez mint index sans option de client pour détecter les clients installés et ouvrir un sélecteur interactif. Les clients détectés sont sélectionnés par défaut. Sélectionnez les clients à configurer, puis confirmez l’invite. Passez une ou plusieurs options de client pour configurer des clients précis sans ouvrir le sélecteur :
Utilisez --yes pour configurer tous les clients détectés sans invite. Si aucun client n’est détecté, passez une option explicite telle que --claude ou --cursor. Utilisez --project avec des options de client pour écrire la configuration du projet dans le répertoire courant :

Configuration et règles

La commande ajoute le serveur mintlify-index à chaque client sélectionné et le configure avec https://index.mintlify.com/mcp. Par défaut, elle met à jour la configuration globale. Avec --project, elle utilise la configuration du projet lorsque le client la prend en charge. La commande ajoute également une règle d’utilisation pour chaque client sélectionné, à l’exception de Zed. Cette règle demande au client d’utiliser l’outil context du MCP Index pour rechercher de la documentation, notamment la syntaxe, la configuration, les migrations et la mise en place. Elle demande au client de privilégier cet outil à la recherche web, car les données d’entraînement peuvent être obsolètes. La règle exclut les concepts généraux de programmation et le débogage de la logique métier. Windsurf ne dispose que d’une configuration MCP globale. Avec --project, la commande écrit toujours l’entrée MCP dans la configuration globale de Windsurf et écrit la règle d’utilisation dans le projet courant. Si vous réexécutez la commande, elle met à jour l’entrée mintlify-index existante et sa règle générée. Elle conserve les autres éléments de configuration. Si une configuration JSON ou JSONC existante n’est pas valide, la commande affiche une erreur sans modifier ce fichier. Les clients pris en charge et leurs fichiers de configuration standard sont les suivants :

mint signup

Créez un nouveau compte Mintlify depuis le terminal.
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. Dans les scripts ou les automatisations, exécutez-le en tant que processus en arrière-plan au lieu de l’attendre de manière synchrone.

Exemples


mint login

S’authentifier avec votre compte Mintlify.
Ouvre une fenêtre de navigateur pour compléter l’authentification. Si le navigateur ne s’ouvre pas, la CLI affiche une URL à ouvrir manuellement et un champ pour coller le code d’autorisation. Les identifiants sont enregistrés dans ~/.config/mintlify/config.json. Si vous avez plus d’un projet, la CLI vous invite à sélectionner un projet par défaut après la connexion. Vous pouvez modifier le projet par défaut ultérieurement avec mint config set subdomain <subdomain>.

mint logout

Supprimer les identifiants stockés.

mint status

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é.

mint add-domain

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 :
Ajoutez d’abord les enregistrements 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.
Lorsque vous passez --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.

Exemples

Ajoutez un domaine personnalisé à la racine :
Ajoutez un domaine personnalisé et servez votre documentation sur /docs :

mint analytics

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.
Toutes les sous-commandes acceptent ces flags partagés :

mint analytics stats

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.

mint analytics feedback

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.

mint analytics conversation

Consultez les analytics des conversations de l’assistant.

mint analytics conversation list

Liste les conversations récentes de l’assistant avec l’horodatage, la première requête utilisateur et la catégorie.

mint analytics conversation view

Affiche le fil de messages complet pour une seule conversation.

mint analytics conversation buckets list

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.

mint analytics conversation buckets view

Liste les fils individuels d’un bucket de conversations.

Exemples


mint config

Gérer les valeurs par défaut persistantes pour les commandes de la CLI. La configuration est enregistrée dans ~/.config/mintlify/config.json.

Clés de configuration


Vérifier les liens internes cassés dans votre documentation.
La commande analyse les liens des fichiers .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. 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.

mint a11y

Vérifier les problèmes d’accessibilité dans votre documentation.
Vérifie les rapports de contraste de couleur et les textes alternatifs manquants sur les images et vidéos.

mint validate

Valider la compilation de votre documentation en mode strict. Se termine en erreur en cas d’avertissements ou d’erreurs. Inclut la validation automatique des spécifications OpenAPI référencées dans votre docs.json.
Utilisez mint validate à la place de la commande autonome mint openapi-check, qui est obsolète.

mint test

Générez des tests à partir des exemples de code de votre documentation. Nécessite une authentification avec mint login.
mint test analyse votre contenu à la recherche de blocs de code, génère des tests unitaires pour les valider et exécute ces tests avec un agent de codage local.

Prérequis

  • Authentifiez-vous avec mint login.
  • Installez le SDK de l’agent de codage que vous souhaitez utiliser :
Seules les pages présentes dans la navigation de votre docs.json apparaissent pour la sélection.

Revenir à une exécution précédente

mint test enregistre un rapport pour chaque exécution terminée. Lorsqu’un rapport enregistré existe, la prochaine exécution interactive commence par des options pour cette exécution :
  • Update tests : réexécute les mêmes pages avec le même agent et le même modèle.
  • Review last test run : consultez les résultats enregistrés sans rien exécuter.
  • Start a brand new test : sélectionnez un agent et des pages depuis le début.

Sortie

La commande mint test écrit dans deux emplacements de votre projet : Ajoutez ces deux chemins à votre .gitignore si vous ne souhaitez pas committer les artefacts de test. Lorsqu’une exécution se termine, la commande affiche un résumé des résultats, par exemple mint test passed: 8 passed, 0 failed, 0 agent errors. La commande se termine avec le code 0 lorsque tous les tests réussissent et 1 dans le cas contraire.

mint export

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.

mint score

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.

Exemples

Vérifications

Le score évalue les domaines suivants : 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.

mint format

mint format réécrit les fichiers sur place. Committez ou stashez vos modifications avant de l’exécuter afin de pouvoir examiner le diff.
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.
Exécutez la commande depuis la racine de votre projet de documentation. Elle parcourt tous les sous-répertoires, en ignorant les chemins correspondant à .gitignore et à toute règle d’exclusion Mintlify. Les fichiers qui correspondent déjà à la sortie canonique restent inchangés.
L’exécution de mint format peut entraîner de nombreuses modifications selon la taille de votre projet. Pour éviter les conflits de fusion et l’introduction de modifications dans d’autres travaux en cours, commencez par résoudre toutes les branches importantes en attente. Créez ensuite une nouvelle branche pour les modifications de formatage et exécutez mint format sur cette branche.
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.

mint new

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.

mint update

Mettre à jour la CLI vers la dernière version.

mint version

Afficher les versions actuelles de la CLI et du client.

Bientôt disponible

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.

Télémétrie

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 et si elle s’exécute dans un terminal interactif. 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. 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 :
Vous pouvez également désactiver la télémétrie en définissant l’une de ces variables d’environnement : Votre préférence est enregistrée dans ~/.config/mintlify/config.json et persiste entre les sessions de la CLI.