Référence des commandes de la CLI Mintlify

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.

Créez un nouveau compte Mintlify depuis le terminal.

mint signup [flags]

Flag	Description
`--firstName`	Votre prénom.
`--lastName`	Votre nom de famille.
`--company`	Le nom de votre entreprise.
`--email`	Adresse e-mail du compte.

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

# Inscription interactive
mint signup

# Inscription avec toutes les informations fournies
mint signup \
  --firstName Jane \
  --lastName Doe \
  --company Acme \
  --email jane@acme.com

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`

Vérifier les pages de documentation à la recherche de prose qui sonne comme de l’IA et obtenir des suggestions de réécriture. Nécessite une authentification avec mint login.

mint deslop [files...] [flags]

Argument	Description
`files`	Facultatif. Chemins ou globs à vérifier. S’ils sont omis, la commande vérifie les pages `.md` et `.mdx` qui ont changé dans votre arbre de travail (diff Git plus fichiers non suivis).

Flag	Description
`--format`	Format de sortie : `table` (par défaut, coloré), `plain` (redirigeable) ou `json`.
`--subdomain`	Sous-domaine de la documentation à utiliser pour la vérification. Par défaut, votre sous-domaine configuré.
`--threshold`	Faire échouer une page lorsque la somme de ses fractions générée par IA et assistée par IA est supérieure à cette valeur, de `0` à `1`. Par défaut `0.5`.
`--fix-whitespace`	Normaliser les espaces de la prose dans les fichiers vérifiés (espaces en fin de ligne, suites de lignes vides et caractères Unicode invisibles). Ignore les blocs de code et le frontmatter.

Pour chaque page signalée, la commande indique la fraction rédigée par IA, les passages spécifiques qui se lisent comme générés par IA avec leurs numéros de ligne, ainsi que des suggestions de réécriture au style humain. Chaque page vérifiée consomme un crédit IA. Les pages de moins de 50 mots sont ignorées et non facturées. Si une page atteint ou dépasse le seuil, ou si une vérification renvoie une erreur, la commande se termine avec le code 1. Si toutes les pages sont propres, la commande se termine avec le code 0. Cela vous permet de l’exécuter dans une boucle de réécriture ou en CI.

Exemples

# Vérifier les pages modifiées dans votre arbre de travail
mint deslop

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

# Vérifier toutes les pages MDX et émettre du JSON pour du scripting
mint deslop "docs/**/*.mdx" --format json

# Nettoyer également les espaces dans les fichiers vérifiés
mint deslop docs/guide.mdx --fix-whitespace

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

Référence des commandes de la CLI Mintlify

Flags globaux

`mint dev`

Exemples

`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

`mint new`

`mint update`

`mint version`

Bientôt disponible

Télémétrie

​Flags globaux

​mint dev

​mint signup

​Exemples

​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

​mint new

​mint update

​mint version

​Bientôt disponible

​Télémétrie

Flags globaux

`mint dev`

`mint signup`

Exemples

`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

`mint new`

`mint update`

`mint version`

Bientôt disponible

Télémétrie