Commandes

Flags globaux

Ces flags sont disponibles pour toutes les commandes.

Flag	Description
`--telemetry`, `-t`	Activer ou désactiver la télémétrie anonyme d’utilisation.
`--help`, `-h`	Afficher l’aide de la commande.
`--version`, `-v`	Afficher la version de la CLI. Alias de `mint version`.

`mint dev`

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

mint dev [flags]

Flag	Description
`--port`	Port pour la prévisualisation locale. Par défaut `3000`.
`--no-open`	Ne pas ouvrir le navigateur automatiquement.
`--groups`	Liste séparée par des virgules de groupes d’utilisateurs à simuler pour la prévisualisation.
`--disable-openapi`	Ignorer le traitement des fichiers OpenAPI pour améliorer les performances.
`--local-schema`	Autoriser les fichiers OpenAPI hébergés localement servis via HTTP.

S’authentifier avec votre compte Mintlify.

mint login

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 déploiement, 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 logout

`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 status

`mint analytics`

Consulter les données d’analytique de votre documentation. Nécessite une authentification avec mint login.

mint analytics <subcommand> [flags]

Toutes les sous-commandes acceptent ces flags partagés :

Flag	Description
`--subdomain`	Sous-domaine de la documentation. Par défaut, la valeur définie avec `mint config set subdomain`, ou le premier projet de votre compte.
`--from`	Date de début au format `YYYY-MM-DD`. Par défaut 7 jours en arrière, ou la valeur définie avec `mint config set dateFrom`.
`--to`	Date de fin au format `YYYY-MM-DD`. Par défaut aujourd’hui, ou la valeur définie avec `mint config set dateTo`.
`--format`	Format de sortie : `plain` (par défaut), `table`, `json` ou `graph`.

`mint analytics stats`

Afficher un résumé des vues, visiteurs, recherches, retours et utilisation de l’assistant.

mint analytics stats [flags]

Flag	Description
`--page`	Filtrer sur une page spécifique.

`mint analytics search`

Afficher les requêtes de recherche avec le nombre de résultats et les taux de clics.

mint analytics search [flags]

Flag	Description
`--query`	Filtrer par sous-chaîne de requête de recherche.
`--page`	Filtrer par page la plus cliquée.

`mint analytics feedback`

Afficher les retours soumis par les utilisateurs.

mint analytics feedback [flags]

Flag	Description
`--type`	Type de retour : `page` (agrégé par page) ou `code` (retours d’extraits de code).
`--page`	Filtrer sur une page spécifique.

`mint analytics conversation`

Consulter les données de conversation de l’assistant.

mint analytics conversation <subcommand> [flags]

`mint analytics conversation list`

Lister les conversations de l’assistant. Chaque entrée inclut un ID de conversation.

mint analytics conversation list [flags]

Flag	Description
`--page`	Filtrer les conversations qui référencent une page spécifique dans les sources.

`mint analytics conversation view <conversation-id>`

Voir une conversation individuelle par ID. Utilisez mint analytics conversation list pour obtenir les IDs.

mint analytics conversation view <conversation-id>

`mint analytics conversation buckets list`

Lister les catégories groupées de conversations. Chaque entrée inclut un ID de catégorie.

mint analytics conversation buckets list

`mint analytics conversation buckets view <bucket-id>`

Voir les conversations dans une catégorie. Utilisez mint analytics conversation buckets list pour obtenir les IDs.

mint analytics conversation buckets view <bucket-id>

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

mint config <subcommand> <key> [value]

Sous-commande	Description
`set <key> <value>`	Définir une valeur de configuration.
`get <key>`	Afficher une valeur de configuration.
`clear <key>`	Supprimer une valeur de configuration.

Clés de configuration

Clé	Description	Utilisé par
`subdomain`	Sous-domaine par défaut de la documentation.	`mint analytics`
`dateFrom`	Date de début par défaut pour les requêtes d’analytique (`YYYY-MM-DD`).	`mint analytics`
`dateTo`	Date de fin par défaut pour les requêtes d’analytique (`YYYY-MM-DD`).	`mint analytics`

`mint broken-links`

Vérifier les liens internes cassés dans votre documentation.

mint broken-links [flags]

La commande exclut les fichiers correspondant aux motifs .mintignore. Les liens pointant vers des fichiers ignorés sont signalés comme cassés.

Flag	Description
`--check-anchors`	Valider également les liens d’ancrage (par exemple, `/page#section`) par rapport aux slugs de titres.
`--check-external`	Vérifier également les URLs externes pour les liens cassés.
`--check-redirects`	Vérifier également que les destinations de redirection dans `docs.json` se résolvent vers des chemins valides.
`--check-snippets`	Vérifier également les liens à l’intérieur des composants `<Snippet>`.

Vérifier les problèmes d’accessibilité dans votre documentation.

mint a11y [flags]

Vérifie les rapports de contraste de couleur et les textes alternatifs manquants sur les images et vidéos.

Flag	Description
`--skip-contrast`	Ignorer les vérifications de contraste de couleur.
`--skip-alt-text`	Ignorer les vérifications de texte alternatif manquant.

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

mint validate [flags]

Flag	Description
`--groups`	Liste séparée par des virgules de groupes d’utilisateurs à simuler pour la validation.
`--disable-openapi`	Ignorer le traitement et la validation des fichiers OpenAPI.
`--local-schema`	Autoriser la validation des fichiers OpenAPI hébergés localement servis via HTTP. Ne prend en charge que HTTPS en production.

La commande autonome mint openapi-check est obsolète. Utilisez mint validate à la place.

`mint export`

Exporter votre documentation sous forme d’archive zip autonome pour la consultation et la distribution hors ligne.

mint export [flags]

Flag	Description
`--output`	Nom du fichier de sortie. Par défaut `export.zip`.
`--groups`	Liste séparée par des virgules de groupes d’utilisateurs pour inclure les pages restreintes.
`--disable-openapi`	Ignorer le traitement OpenAPI.

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.

mint score [url] [flags]

Argument	Description
`url`	Facultatif. URL du site de documentation à vérifier. S’il est omis, la commande évalue votre sous-domaine configuré (depuis `mint config` ou le sous-domaine associé à votre compte connecté).

Flag	Description
`--format`	Format de sortie : `table` (par défaut, coloré), `plain` (TSV pour redirection) ou `json`.

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

# Évaluer votre sous-domaine par défaut
mint score

# Évaluer un site spécifique
mint score docs.example.com

Vérifications

Le score évalue les domaines suivants :

Vérification	Ce qu’elle vérifie
`llmsTxtExists`	Les agents peuvent atteindre un fichier llms.txt à la racine du site.
`llmsTxtValid`	Le fichier `llms.txt` suit le format attendu avec des titres, un résumé en citation et des liens Markdown.
`llmsTxtSize`	Le fichier `llms.txt` est dans le seuil de taille pour que les agents puissent le consommer sans troncature.
`llmsTxtLinksResolve`	Les liens dans `llms.txt` pointent vers des pages actives.
`llmsTxtLinksMarkdown`	Les liens dans `llms.txt` utilisent la syntaxe Markdown.
`llmsTxtDirective`	Le fichier `llms.txt` contient des directives d’utilisation.
`llmsTxtFullExists`	Un fichier llms-full.txt est disponible pour les agents qui ont besoin du contenu complet. S’exécute indépendamment de `llmsTxtExists`.
`llmsTxtFullSize`	Le fichier `llms-full.txt` a une taille raisonnable pour que les agents puissent le traiter.
`llmsTxtFullValid`	Le fichier `llms-full.txt` contient un contenu valide avec des titres.
`llmsTxtFullLinksResolve`	Les liens dans `llms-full.txt` pointent vers des pages actives.
`skillMd`	Les agents peuvent atteindre un fichier skill.md pour l’utilisation d’outils par les agents.
`contentNegotiationMarkdown`	Le site renvoie du Markdown lorsque les agents le demandent via la négociation de contenu.
`contentNegotiationPlaintext`	Le site renvoie du texte brut lorsque les agents le demandent via la négociation de contenu.
`mcpServerDiscoverable`	Les agents peuvent découvrir un serveur MCP pour les agents basés sur des outils.
`mcpToolCount`	Le serveur MCP expose au moins un outil.
`openApiSpec`	Une spécification OpenAPI ou Swagger est disponible à un chemin standard.
`robotsTxtAllowsAI`	Le fichier `robots.txt` ne bloque pas les robots d’indexation IA.
`sitemapExists`	Un plan du site est disponible pour la découverte des pages.
`structuredData`	La page d’accueil contient des données structurées JSON-LD (`<script type="application/ld+json">`). Indique le nombre de blocs JSON-LD et les types de schémas trouvés.
`responseLatency`	Le site répond dans un délai acceptable pour les agents.

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 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 new [directory] [flags]

Flag	Description
`--name`	Nom du projet. La CLI le demande s’il n’est pas fourni en mode interactif.
`--theme`	Thème du projet. La CLI le demande s’il n’est pas fourni en mode interactif.
`--template`	Modèle prédéfini. La CLI le demande s’il n’est pas fourni en mode interactif.
`--force`	Écraser le répertoire sans confirmation.

`mint update`

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

mint update

`mint version`

Afficher les versions actuelles de la CLI et du client.

mint version

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.

Commande	Description
`mint ai`	Outils de documentation assistés par IA.
`mint test`	Tests de documentation.
`mint signup`	Inscription de compte depuis la CLI.
`mint mcp`	Serveur MCP pour la documentation.

Télémétrie

La CLI collecte des données de télémétrie anonymes 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 et l’architecture. Mintlify ne collecte pas d’informations personnellement identifiables, 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 :

# Désactiver la télémétrie
mint --telemetry false

# Réactiver la télémétrie
mint --telemetry true

Vous pouvez également désactiver la télémétrie en définissant l’une de ces variables d’environnement :

Variable	Valeur	Description
`MINTLIFY_TELEMETRY_DISABLED`	`1`	Désactiver la télémétrie de la CLI Mintlify.
`DO_NOT_TRACK`	`1`	Désactiver la télémétrie en utilisant le standard Console Do Not Track.

Votre préférence est enregistrée dans ~/.config/mintlify/config.json et persiste entre les sessions de la CLI.

Prise en main

Organiser

Personnaliser

Créer du contenu

Documenter des API

Déployer

Optimisation

Flags globaux

`mint dev`

`mint logout`

`mint status`

`mint analytics`

`mint analytics stats`

`mint analytics search`

`mint analytics feedback`

`mint analytics conversation`

`mint analytics conversation list`

`mint analytics conversation view <conversation-id>`

`mint analytics conversation buckets list`

`mint analytics conversation buckets view <bucket-id>`

`mint config`

Clés de configuration

`mint broken-links`

`mint validate`

`mint export`

`mint score`

Exemples

Vérifications

`mint new`

`mint update`

`mint version`

Bientôt disponible

Télémétrie

​Flags globaux

​mint dev

​mint login

​mint logout

​mint status

​mint analytics

​mint analytics stats

​mint analytics search

​mint analytics feedback

​mint analytics conversation

​mint analytics conversation list

​mint analytics conversation view <conversation-id>

​mint analytics conversation buckets list

​mint analytics conversation buckets view <bucket-id>

​mint config

​Clés de configuration

​mint broken-links

​mint a11y

​mint validate

​mint export

​mint score

​Exemples

​Vérifications

​mint new

​mint update

​mint version

​Bientôt disponible

​Télémétrie

Flags globaux

`mint dev`

`mint login`

`mint logout`

`mint status`

`mint analytics`

`mint analytics stats`

`mint analytics search`

`mint analytics feedback`

`mint analytics conversation`

`mint analytics conversation list`

`mint analytics conversation view <conversation-id>`

`mint analytics conversation buckets list`

`mint analytics conversation buckets view <bucket-id>`

`mint config`

Clés de configuration

`mint broken-links`

`mint a11y`

`mint validate`

`mint export`

`mint score`

Exemples

Vérifications

`mint new`

`mint update`

`mint version`

Bientôt disponible

Télémétrie