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. |
| 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.
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.
Supprimer les identifiants stockés.
Afficher le compte et l’organisation associés à votre session actuelle.
Consulter les données d’analytique de votre documentation. Nécessite une authentification avec mint login.
mint analytics <subcommand> [flags]
| Flag | Description |
|---|
--subdomain | Sous-domaine de la documentation. Par défaut, la valeur définie avec mint config set subdomain. |
--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. |
--agent | Sortie JSON. Équivalent à --format json. Également activé automatiquement lorsque la variable d’environnement CLAUDECODE est 1. |
mint analytics stats [flags]
| Flag | Description |
|---|
--page | Filtrer sur une page spécifique. |
--humans | Afficher uniquement le trafic humain. |
--agents | Afficher uniquement le trafic des agents IA. |
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 [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
mint analytics conversation <subcommand> [flags]
mint analytics conversation list
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>
mint analytics conversation list pour obtenir les IDs.
mint analytics conversation view <conversation-id>
mint analytics conversation buckets list
mint analytics conversation buckets list
mint analytics conversation buckets view <bucket-id>
mint analytics conversation buckets list pour obtenir les IDs.
mint analytics conversation buckets view <bucket-id>
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é | 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 |
Vérifier les liens internes cassés dans votre documentation.
mint broken-links [flags]
| 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-snippets | Vérifier également les liens à l’intérieur des composants <Snippet>. |
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.
| Flag | Description |
|---|
--skip-contrast | Ignorer les vérifications de contraste de couleur. |
--skip-alt-text | Ignorer les vérifications de texte alternatif manquant. |
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.
| 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.
Créer un fichier de workflow de manière interactive.
La CLI vous demande un nom, un type de déclencheur et d’autres paramètres, puis crée un fichier .md dans .mintlify/workflows/.
Exporter votre documentation sous forme d’archive zip autonome pour la consultation et la distribution hors ligne.
| 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. |
Créer un nouveau projet de documentation à partir du modèle de démarrage Mintlify.
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. |
--force | Écraser le répertoire sans confirmation. |
Mettre à jour la CLI vers la dernière version.
Afficher les versions actuelles de la CLI et du client.
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. |
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
| 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. |
~/.config/mintlify/config.json et persiste entre les sessions de la CLI. 
