Passer au contenu principal

Flags globaux

Ces flags sont disponibles pour toutes les commandes.

mint dev

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

mint login

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

Créez, listez et supprimez des automatisations depuis le terminal. Nécessite une authentification avec mint login.
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 : 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.
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

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

mint automations list

Liste les automatisations pour le déploiement actuel.
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 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.

Clés de configuration


Vérifier les liens internes cassés dans votre documentation.
La commande exclut les fichiers correspondant aux motifs .mintignore. Les liens pointant vers des fichiers ignorés sont signalés comme cassés.

mint a11y

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.

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

Vérifications

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.

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 update

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

mint version

Afficher les versions actuelles de la CLI et du client.

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.

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