Référence des commandes de la CLI Mintlify

Ces flags sont disponibles pour toutes les commandes.

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

mint dev [flags]

Créez un nouveau compte Mintlify depuis le terminal.

mint signup [flags]

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.

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

Supprimer les identifiants stockés.

mint logout

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

Ajoutez un domaine personnalisé à votre déploiement depuis le terminal. Nécessite une authentification avec mint login.

mint add-domain <domain> [--basePath <path>]

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 _acme-challenge → <value>
TXT _cf-custom-hostname → <value>
CNAME @ → cname.mintlify.builders

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.

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.

Ajoutez un domaine personnalisé à la racine :

mint add-domain docs.example.com

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

mint add-domain example.com --basePath /docs

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

mint automations <subcommand> [flags]

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

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.

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]

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.

# 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

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.

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

mint automations delete <id> [flags]

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]

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.

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 une page spécifique
mint broken-links --files introduction.mdx

# Vérifier les pages correspondant à un glob
mint broken-links --files "guides/**/*.mdx"

# Passer plusieurs chemins
mint broken-links --files introduction.mdx --files "guides/**/*.mdx"

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.

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]

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

mint export [flags]

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.

mint score [url] [flags]

La commande affiche un score global de préparation et un détail des vérifications individuelles avec des indicateurs de réussite/échec.

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

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

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.

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]

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.

# 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

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.

mint format

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.

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.

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]

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

mint update

Afficher les versions actuelles de la CLI et du client.

mint version

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

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