mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
98996bc026
* Document --template flag for mint new command Generated-By: mintlify-agent * docs: clarify --template flag description --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
403 lines
11 KiB
Plaintext
403 lines
11 KiB
Plaintext
---
|
|
title: "Commandes"
|
|
description: "Référence complète de toutes les commandes et options de la CLI Mintlify."
|
|
keywords: ["CLI", "mint", "commandes", "flags", "référence"]
|
|
---
|
|
|
|
<div id="global-flags">
|
|
## Flags globaux
|
|
</div>
|
|
|
|
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`. |
|
|
|
|
<div id="mint-dev">
|
|
## `mint dev`
|
|
</div>
|
|
|
|
Démarrer une prévisualisation locale de votre documentation.
|
|
|
|
```bash
|
|
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. |
|
|
|
|
---
|
|
|
|
<div id="mint-login">
|
|
## `mint login`
|
|
</div>
|
|
|
|
S'authentifier avec votre compte Mintlify.
|
|
|
|
```bash
|
|
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>`.
|
|
|
|
---
|
|
|
|
<div id="mint-logout">
|
|
## `mint logout`
|
|
</div>
|
|
|
|
Supprimer les identifiants stockés.
|
|
|
|
```bash
|
|
mint logout
|
|
```
|
|
|
|
---
|
|
|
|
<div id="mint-status">
|
|
## `mint status`
|
|
</div>
|
|
|
|
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é.
|
|
|
|
```bash
|
|
mint status
|
|
```
|
|
|
|
---
|
|
|
|
<div id="mint-analytics">
|
|
## `mint analytics`
|
|
</div>
|
|
|
|
Consulter les données d'analytique de votre documentation. Nécessite une authentification avec `mint login`.
|
|
|
|
```bash
|
|
mint analytics <subcommand> [flags]
|
|
```
|
|
|
|
Toutes les sous-commandes acceptent ces flags partagés :
|
|
|
|
| Flag | Description |
|
|
| --- | --- |
|
|
| `--subdomain` | Sous-domaine de la documentation. Par défaut, la valeur définie avec `mint config set subdomain`, ou le premier projet de votre compte. |
|
|
| `--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`. |
|
|
|
|
<div id="mint-analytics-stats">
|
|
### `mint analytics stats`
|
|
</div>
|
|
|
|
Afficher un résumé des vues, visiteurs, recherches, retours et utilisation de l'assistant.
|
|
|
|
```bash
|
|
mint analytics stats [flags]
|
|
```
|
|
|
|
| Flag | Description |
|
|
| --- | --- |
|
|
| `--page` | Filtrer sur une page spécifique. |
|
|
|
|
<div id="mint-analytics-search">
|
|
### `mint analytics search`
|
|
</div>
|
|
|
|
Afficher les requêtes de recherche avec le nombre de résultats et les taux de clics.
|
|
|
|
```bash
|
|
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. |
|
|
|
|
<div id="mint-analytics-feedback">
|
|
### `mint analytics feedback`
|
|
</div>
|
|
|
|
Afficher les retours soumis par les utilisateurs.
|
|
|
|
```bash
|
|
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. |
|
|
|
|
<div id="mint-analytics-conversation">
|
|
### `mint analytics conversation`
|
|
</div>
|
|
|
|
Consulter les données de conversation de l'assistant.
|
|
|
|
```bash
|
|
mint analytics conversation <subcommand> [flags]
|
|
```
|
|
|
|
<div id="mint-analytics-conversation-list">
|
|
#### `mint analytics conversation list`
|
|
</div>
|
|
|
|
Lister les conversations de l'assistant. Chaque entrée inclut un ID de conversation.
|
|
|
|
```bash
|
|
mint analytics conversation list [flags]
|
|
```
|
|
|
|
| Flag | Description |
|
|
| --- | --- |
|
|
| `--page` | Filtrer les conversations qui référencent une page spécifique dans les sources. |
|
|
|
|
<div id="mint-analytics-conversation-view-conversation-id">
|
|
#### `mint analytics conversation view <conversation-id>`
|
|
</div>
|
|
|
|
Voir une conversation individuelle par ID. Utilisez `mint analytics conversation list` pour obtenir les IDs.
|
|
|
|
```bash
|
|
mint analytics conversation view <conversation-id>
|
|
```
|
|
|
|
<div id="mint-analytics-conversation-buckets-list">
|
|
#### `mint analytics conversation buckets list`
|
|
</div>
|
|
|
|
Lister les catégories groupées de conversations. Chaque entrée inclut un ID de catégorie.
|
|
|
|
```bash
|
|
mint analytics conversation buckets list
|
|
```
|
|
|
|
<div id="mint-analytics-conversation-buckets-view-bucket-id">
|
|
#### `mint analytics conversation buckets view <bucket-id>`
|
|
</div>
|
|
|
|
Voir les conversations dans une catégorie. Utilisez `mint analytics conversation buckets list` pour obtenir les IDs.
|
|
|
|
```bash
|
|
mint analytics conversation buckets view <bucket-id>
|
|
```
|
|
|
|
---
|
|
|
|
<div id="mint-config">
|
|
## `mint config`
|
|
</div>
|
|
|
|
Gérer les valeurs par défaut persistantes pour les commandes de la CLI. La configuration est enregistrée dans `~/.config/mintlify/config.json`.
|
|
|
|
```bash
|
|
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. |
|
|
|
|
<div id="configuration-keys">
|
|
### Clés de configuration
|
|
</div>
|
|
|
|
| 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` |
|
|
|
|
---
|
|
|
|
<div id="mint-broken-links">
|
|
## `mint broken-links`
|
|
</div>
|
|
|
|
Vérifier les liens internes cassés dans votre documentation.
|
|
|
|
```bash
|
|
mint broken-links [flags]
|
|
```
|
|
|
|
La commande exclut les fichiers correspondant aux motifs [.mintignore](/fr/organize/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-snippets` | Vérifier également les liens à l'intérieur des composants `<Snippet>`. |
|
|
|
|
---
|
|
|
|
<div id="mint-a11y">
|
|
## `mint a11y`
|
|
</div>
|
|
|
|
Vérifier les problèmes d'accessibilité dans votre documentation.
|
|
|
|
```bash
|
|
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. |
|
|
|
|
---
|
|
|
|
<div id="mint-validate">
|
|
## `mint validate`
|
|
</div>
|
|
|
|
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`.
|
|
|
|
```bash
|
|
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. |
|
|
|
|
<Note>
|
|
La commande autonome `mint openapi-check` est obsolète. Utilisez `mint validate` à la place.
|
|
</Note>
|
|
|
|
---
|
|
|
|
<div id="mint-workflow">
|
|
## `mint workflow`
|
|
</div>
|
|
|
|
Créer un fichier de [workflow](/fr/agent/workflows) de manière interactive.
|
|
|
|
```bash
|
|
mint workflow
|
|
```
|
|
|
|
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/`.
|
|
|
|
---
|
|
|
|
<div id="mint-export">
|
|
## `mint export`
|
|
</div>
|
|
|
|
Exporter votre documentation sous forme d'archive zip autonome pour la consultation et la distribution hors ligne.
|
|
|
|
```bash
|
|
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](/fr/deploy/export) pour plus de détails.
|
|
|
|
---
|
|
|
|
<div id="mint-new">
|
|
## `mint new`
|
|
</div>
|
|
|
|
Créer un nouveau projet de documentation à partir du modèle de démarrage Mintlify ou d'un modèle prédéfini.
|
|
|
|
```bash
|
|
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](/fr/customize/themes) 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. |
|
|
|
|
---
|
|
|
|
<div id="mint-update">
|
|
## `mint update`
|
|
</div>
|
|
|
|
Mettre à jour la CLI vers la dernière version.
|
|
|
|
```bash
|
|
mint update
|
|
```
|
|
|
|
---
|
|
|
|
<div id="mint-version">
|
|
## `mint version`
|
|
</div>
|
|
|
|
Afficher les versions actuelles de la CLI et du client.
|
|
|
|
```bash
|
|
mint version
|
|
```
|
|
|
|
---
|
|
|
|
<div id="coming-soon">
|
|
## Bientôt disponible
|
|
</div>
|
|
|
|
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. |
|
|
|
|
---
|
|
|
|
<div id="telemetry">
|
|
## Télémétrie
|
|
</div>
|
|
|
|
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` :
|
|
|
|
```bash
|
|
# 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](https://consoledonottrack.com/). |
|
|
|
|
Votre préférence est enregistrée dans `~/.config/mintlify/config.json` et persiste entre les sessions de la CLI.
|