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

Créez, listez et supprimez des automatisations depuis le terminal. Nécessite une authentification avec mint login.

mint automations <subcommand> [flags]

mint workflow et mint workflows continuent de fonctionner en tant qu’alias de mint automations, afin que les scripts existants restent opérationnels. Les nouveaux scripts doivent utiliser mint automations.

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

Flag	Description
`--subdomain`	Sous-domaine de la documentation. Par défaut, utilise la valeur définie avec `mint config set subdomain`, ou le premier projet de votre compte.
`--format`	Format de sortie : `table` (par défaut, lisible) ou `json` (brut, lisible par machine).

Lorsque --format json est défini, les erreurs sont écrites sur stderr sous la forme Error: <message> et la commande se termine avec un statut non nul, afin que vous puissiez rediriger la sortie réussie vers d’autres outils.

`mint automations create`

Crée une nouvelle automatisation. Vous pouvez passer la définition de l’automatisation en ligne avec des flags, ou pointer vers un fichier JSON ou YAML avec --file.

mint automations create [flags]

Flag	Description
`--name`	Nom de l’automatisation. Obligatoire sauf si `--file` est fourni.
`--prompt`	Instructions ajoutées au prompt de base de l’automatisation à chaque exécution.
`--type`	Type d’automatisation. L’une des valeurs suivantes : `changelog`, `source-code-agent`, `translations`, `writing-style`, `typo-check`, `broken-link-detection`, `seo-metadata-audit`, `assistant-docs-updates` ou `contextual-feedback-docs-updates`. Omettez pour une automatisation personnalisée.
`--cron`	Expression cron pour un trigger planifié. Mutuellement exclusif avec `--push-repo`.
`--push-repo`	Dépôt (`owner/repo`) pour un trigger de push. Répétable pour écouter plusieurs dépôts. Mutuellement exclusif avec `--cron`.
`--context-repo`	Dépôt de contexte supplémentaire (`owner/repo`) que l’agent lit lors de l’exécution de l’automatisation. Répétable, jusqu’à 10 au total.
`--automerge`	Fusionne automatiquement les pull requests ouvertes par cette automatisation. Consultez Configurer l’automerge pour les prérequis de configuration.
`--file`	Chemin vers un fichier JSON ou YAML contenant le corps complet de l’automatisation. Remplace les flags en ligne.

Fournissez exactement un trigger : passez --cron pour une automatisation planifiée ou un ou plusieurs flags --push-repo pour une automatisation déclenchée par push.

Exemples

# Automatisation de traductions planifiée
mint automations create \
  --name "Translate content" \
  --type translations \
  --cron "0 6 * * *"

# Automatisation déclenchée par push avec contexte supplémentaire
mint automations create \
  --name "Sync API reference" \
  --type source-code-agent \
  --push-repo my-org/api \
  --context-repo my-org/shared-types \
  --automerge

# Créer à partir d'un fichier
mint automations create --file automation.yaml

Un fichier d’automatisation utilise la même structure que les flags en ligne. Le champ on contient le trigger :

name: Translate content
type: translations
on:
  cron: "0 6 * * *"
prompt: Prefer formal tone in French translations.
automerge: false
context:
  - repo: my-org/shared-content

`mint automations list`

Liste les automatisations pour le déploiement actuel.

mint automations list [flags]

La sortie sous forme de tableau par défaut affiche l’ID, le nom, le type, le trigger et le statut de chaque automatisation. Utilisez --format json pour obtenir les objets automatisation complets.

`mint automations delete`

Supprime une automatisation par ID. Utilisez mint automations list pour obtenir l’ID.

mint automations delete <id> [flags]

Argument	Description
`id`	ID du schéma de l’automatisation à supprimer.

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

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

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

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

Détecter la prose qui semble générée par IA dans les pages de documentation et obtenir des suggestions d’humanisation. Nécessite une authentification avec mint login.

mint deslop [files..] [flags]

Sans argument, la commande vérifie les pages .md et .mdx modifiées dans git (indexées, non indexées et non suivies). Dans un dépôt de documentation contenant un fichier docs.json, les fichiers modifiés sont automatiquement filtrés pour ne conserver que les pages référencées dans votre navigation, de sorte que les pages .mintignored et non publiées sont ignorées. Vous pouvez également passer des chemins de fichiers ou des globs explicites. Chaque page est évaluée sur la fraction de prose qui semble écrite par une IA. Les pages qui atteignent ou dépassent --threshold échouent, et la commande se termine avec le code de sortie 1 si une page est signalée ou en erreur. Les pages entièrement humaines n’échouent jamais, même avec --threshold 0.

Argument	Description
`files`	Facultatif. Un ou plusieurs chemins de fichiers ou globs à vérifier. Par défaut, les pages modifiées dans git.

Flag	Description
`--subdomain`	Sous-domaine de la documentation. Par défaut, la valeur définie avec `mint config set subdomain`.
`--format`	Format de sortie : `table` (par défaut, coloré), `plain` (redirigeable) ou `json` (adapté aux agents).
`--threshold`	Faire échouer une page lorsque sa fraction écrite par IA atteint cette valeur. Nombre entre `0` et `1`. Par défaut `0.5`.
`--fix-whitespace`	Normaliser les espaces de la prose dans les fichiers vérifiés avant l’évaluation. Réécrit les fichiers localement sans appel au serveur.

Pour chaque page signalée, la sortie affiche le pourcentage écrit par IA, les plages de lignes signalées, la prose incriminée et des suggestions de réécriture que vous pouvez appliquer.

La vérification des pages consomme des crédits IA. --fix-whitespace s’exécute localement et ne consomme pas de crédits. Si le lot rencontre une erreur de crédits ou de disponibilité, les pages restantes sont ignorées plutôt que retentées.

Exemples

# Vérifier les pages modifiées dans git
mint deslop

# Vérifier une page spécifique
mint deslop docs/guide.mdx

# Vérifier des pages par glob avec une sortie adaptée aux agents
mint deslop "docs/**/*.mdx" --format json

# Ne faire échouer que les pages les plus manifestement écrites par IA
mint deslop --threshold 0.8

# Normaliser les espaces de la prose et revérifier en une seule passe
mint deslop --fix-whitespace

Correction des espaces

--fix-whitespace nettoie de manière déterministe les espaces de la prose dans chaque fichier vérifié : espaces en fin de ligne, séries de lignes vides, espaces unicode et de largeur nulle, et doubles espaces internes. Les blocs de code délimités, le code en ligne et le frontmatter sont laissés intacts. Comme cela s’exécute localement, il est sans danger de l’inclure dans des hooks de pré-commit ou en CI.

Sortie JSON

--format json écrit un unique objet JSON sur stdout avec un tableau results (une entrée par fichier, indexée par path) et un bloc summary. Les erreurs sont signalées par fichier et comptabilisées dans summary.errors. Ce format est conçu pour les agents qui bouclent : vérifier, réécrire les passages signalés, puis relancer jusqu’à ce que la commande se termine avec 0. La CLI appelle le même service de détection que celui exposé par l’Admin API. Utilisez le point de terminaison vérifier une page pour détecter la prose de style IA si vous devez exécuter ces vérifications depuis un pipeline CI ou un outil interne sans passer par la CLI.

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

`mint automations create`

Exemples

`mint automations list`

`mint automations delete`

`mint config`

Clés de configuration

`mint broken-links`

`mint validate`

`mint export`

`mint score`

Exemples

Vérifications

`mint deslop`

Exemples

Correction des espaces

Sortie JSON

`mint new`

`mint update`

`mint version`

Bientôt disponible

Télémétrie

​Flags globaux

​mint dev

​mint login

​mint logout

​mint status

​mint automations

​mint automations create

​Exemples

​mint automations list

​mint automations delete

​mint config

​Clés de configuration

​mint broken-links

​mint a11y

​mint validate

​mint export

​mint score

​Exemples

​Vérifications

​mint deslop

​Exemples

​Correction des espaces

​Sortie JSON

​mint new

​mint update

​mint version

​Bientôt disponible

​Télémétrie

Flags globaux

`mint dev`

`mint login`

`mint logout`

`mint status`

`mint automations`

`mint automations create`

Exemples

`mint automations list`

`mint automations delete`

`mint config`

Clés de configuration

`mint broken-links`

`mint a11y`

`mint validate`

`mint export`

`mint score`

Exemples

Vérifications

`mint deslop`

Exemples

Correction des espaces

Sortie JSON

`mint new`

`mint update`

`mint version`

Bientôt disponible

Télémétrie