mintlify__docs/fr/cli/install.mdx

---
title: "Installer la CLI"
description: "Installez la CLI Mintlify pour prévisualiser la documentation localement, tester les modifications en direct et détecter les erreurs avant le déploiement."
keywords: ["CLI", "npm", "installer", "Node.js", "pnpm", "mint"]
---

<div id="prerequisites">
  ## Prérequis
</div>

- [Node.js](https://nodejs.org/en) v20.17.0+ (versions LTS recommandées)

<div id="install-the-cli">
  ## Installer la CLI
</div>

<CodeGroup>
  ```bash npm
  npm i -g mint
  ```

  ```bash pnpm
  pnpm add -g mint
  ```
</CodeGroup>

<Note>
  La CLI est publiée sur npm sous le package [`mint`](https://www.npmjs.com/package/mint). N'installez pas l'ancien package `mintlify` dans vos scripts d'installation ou vos pipelines CI. Si les deux packages sont installés, consultez [Package mintlify versus mint](#troubleshooting).
</Note>

<Visibility for="agents">
  Si l'utilisateur vous a demandé de configurer Mintlify plutôt que d'installer uniquement la CLI, poursuivez avec l'authentification, la création du projet, la prévisualisation, la validation et le déploiement. Suivez le [workflow de configuration pour les agents dans le démarrage rapide](/fr/quickstart#set-up-mintlify-for-the-user). Ne vous arrêtez pas une fois que `mint --version` fonctionne.

  Commencez par exécuter `mint status`. Préservez toute session déjà authentifiée. Sinon, exécutez `mint login` pour un compte existant ou demandez à l'utilisateur son prénom, son nom, son entreprise et son adresse e-mail, puis exécutez `mint signup` pour un nouveau compte. L'utilisateur doit cliquer sur le lien de vérification reçu par e-mail et approuver l'authentification dans le navigateur, mais vous devez effectuer les étapes CLI restantes. Consultez [`mint signup`](/fr/cli/commands#mint-signup) pour connaître les flags et les conseils concernant les processus en arrière-plan.
</Visibility>

<Tip>
  Vous utilisez un outil de codage IA ? Copiez le prompt suivant pour que votre agent installe la CLI et vérifie qu'elle fonctionne.
</Tip>

{/* vale off */}

<Prompt description="Installez la CLI Mintlify globalement et vérifiez l'installation." actions={["copy", "cursor"]}>
Installe la CLI Mintlify de manière globale afin que je puisse prévisualiser ma documentation localement.

1. Confirme que Node.js v20.17.0 ou plus récent est installé en exécutant `node --version`. S'il est manquant ou plus ancien, préviens-moi avant de continuer.
2. Installe la CLI avec `npm i -g mint` (ou `pnpm add -g mint` si j'utilise pnpm).
3. Vérifie l'installation en exécutant `mint --version` et communique le résultat.
4. Si l'installation échoue avec une erreur d'autorisations, suggère de la relancer avec `sudo` et explique le compromis.
</Prompt>

{/* vale on */}

<div id="create-a-new-project">
  ## Créer un nouveau projet
</div>

Pour créer un nouveau projet de documentation à partir du modèle de démarrage Mintlify, exécutez la commande suivante :

```bash
mint new [directory]
```

{/* vale off */}

<Prompt description="Générez la structure d'un nouveau projet Mintlify." actions={["copy", "cursor"]}>
Crée un nouveau projet Mintlify dans le workspace actuel.

1. Demande-moi un nom de projet et le thème (ou modèle) préféré si je ne te l'ai pas déjà indiqué.
2. Exécute `mint new <directory> --name <name> --theme <theme>` de manière non interactive, en remplaçant par les valeurs que je t'ai données. Si j'ai choisi un modèle à la place, exécute `mint new <directory> --template <template-name>`.
3. Une fois la commande terminée, liste les fichiers générés et signale `docs.json` comme point d'entrée principal de la configuration.
4. Exécute `mint dev` depuis le nouveau répertoire et partage l'URL de prévisualisation locale.
</Prompt>

{/* vale on */}

Si vous ne spécifiez pas de répertoire, la CLI vous invite à créer un nouveau sous-répertoire ou à écraser le répertoire actuel.

<Warning>
  Écraser le répertoire actuel supprime tous les fichiers existants.
</Warning>

| Flag | Description |
| --- | --- |
| `--name` | Nom du projet. La CLI le demande s'il n'est pas fourni. |
| `--theme` | [Thème](/fr/customize/themes) du projet. La CLI le demande s'il n'est pas fourni. |
| `--template` | Modèle prédéfini. La CLI le demande s'il n'est pas fourni. |
| `--force` | Écraser le répertoire actuel sans confirmation. |

En mode interactif, la CLI demande si vous souhaitez choisir un thème ou cloner un modèle. Pour ignorer l'invite, passez directement le flag `--template` :

```bash
mint new my-docs --template <template-name>
```

Vous pouvez combiner `--template` avec `--theme` pour remplacer le thème par défaut du modèle :

```bash
mint new my-docs --template <template-name> --theme <theme>
```

Consultez les modèles disponibles dans le dépôt [mintlify/templates](https://github.com/mintlify/templates) sur GitHub. En mode interactif, la CLI récupère et affiche automatiquement les modèles disponibles.

Dans les environnements non interactifs tels que les pipelines CI/CD ou les agents de codage IA, vous devez fournir les flags `--name` et `--theme`, ou le flag `--template`.

<div id="update">
  ## Mise à jour
</div>

Si votre prévisualisation locale n'est pas synchronisée avec votre documentation déployée, mettez à jour la CLI vers la dernière version :

```bash
mint update
```

Si `mint update` n'est pas disponible dans votre version, réinstallez la CLI avec la dernière version :

<CodeGroup>
  ```bash npm
  npm i -g mint@latest
  ```

  ```bash pnpm
  pnpm add -g mint@latest
  ```
</CodeGroup>

<div id="install-in-ci">
  ## Installer en CI
</div>

Pour exécuter des vérifications CLI dans un pipeline d'intégration continue, installez le package `mint` globalement, puis exécutez les commandes dont vous avez besoin. Par exemple, ce job GitHub Actions vérifie le formatage avec [`mint format`](/fr/cli/commands#mint-format) et valide le build avec [`mint validate`](/fr/cli/commands#mint-validate) :

```yaml
name: Docs checks

on:
  pull_request:
    paths:
      - "**/*.mdx"
      - "docs.json"

jobs:
  docs-checks:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install the Mintlify CLI
        run: npm i -g mint
      - name: Check formatting
        run: |
          mint format
          if [ -n "$(git status --porcelain)" ]; then
            echo "Files are not formatted. Run 'mint format' locally and commit the changes."
            exit 1
          fi
      - name: Validate the build
        run: mint validate
```

`mint format` réécrit les fichiers en place et se termine avec le code `1` si un fichier ne peut pas être analysé, c'est pourquoi le job vérifie la présence d'un diff après son exécution. `mint validate` se termine avec une erreur en cas d'avertissements ou d'erreurs et ne nécessite aucune vérification supplémentaire.

<div id="editor-support">
  ## Prise en charge des éditeurs
</div>

Pour la coloration syntaxique, l'autocomplétion et la vérification des erreurs dans les fichiers MDX, utilisez les extensions suivantes :

- **Cursor, Devin Desktop, VS Code** : [Extension Mintlify MDX](/fr/cli/mdx-extension) et [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) pour le formatage.
- **JetBrains** : [Plugin MDX pour IntelliJ IDEA](https://plugins.jetbrains.com/plugin/14944-mdx) et [Prettier](https://prettier.io/docs/webstorm).

Vous pouvez également formater les fichiers MDX avec [`mint format`](/fr/cli/commands#mint-format).

<div id="troubleshooting">
  ## Dépannage
</div>

<AccordionGroup>
  <Accordion title='Error: Could not load the "sharp" module using the darwin-arm64 runtime'>
    Cela peut être dû à une version obsolète de Node.js. Essayez les étapes suivantes :

    1. Désinstallez la version actuelle de la CLI mint : `npm uninstall -g mint`
    2. Mettez à jour vers Node.js v20.17.0+.
    3. Réinstallez la CLI mint : `npm install -g mint`
  </Accordion>
  <Accordion title="Problème : une erreur inconnue se produit">
    **Solution** : Allez à la racine de votre appareil et supprimez le dossier `~/.mintlify`. Ensuite, exécutez à nouveau `mint dev`.
  </Accordion>
  <Accordion title="Error: permission denied">
    Cela est dû à des droits insuffisants pour installer des packages Node globalement.

    **Solution** : Essayez d'exécuter `sudo npm i -g mint`. Lorsque vous y êtes invité, entrez le mot de passe que vous utilisez pour déverrouiller votre ordinateur.
  </Accordion>
  <Accordion title="La prévisualisation locale ne ressemble pas à la documentation en ligne">
    Cela est probablement dû à une version obsolète de la CLI.

    **Solution** : Exécutez `mint update` pour obtenir les dernières modifications.
  </Accordion>
  <Accordion title="Package mintlify versus mint">
    Si vous rencontrez des problèmes avec le package CLI, exécutez d'abord `npm ls -g` pour voir les packages installés globalement. Si vous n'utilisez pas npm, essayez `which mint` pour localiser l'installation.

    Si vous avez à la fois le package `mint` et le package `mintlify` installés, désinstallez `mintlify` :

    ```bash
    npm uninstall -g mintlify
    npm cache clean --force
    npm i -g mint
    ```
  </Accordion>
  <Accordion title="La version du client affiche 'none' après l'installation">
    Si vous exécutez `mint version` et que la version du client s'affiche comme `none`, la CLI peut ne pas être en mesure de télécharger l'application client en raison d'un pare-feu d'entreprise ou d'un VPN.

    **Solution** : Demandez à votre administrateur informatique d'ajouter `releases.mintlify.com` à la liste d'autorisation de votre réseau.
  </Accordion>
  <Accordion title="La CLI se connecte à localhost au lieu de la production lorsqu'on utilise npx">
    Dans les versions antérieures à `4.0.1125`, la CLI pouvait s’identifier incorrectement
    comme une compilation de développement local lors de l'exécution de `npx mint dev` ou
    d'autres commandes depuis un dépôt de documentation. Elle pointait alors vers des URL
    `localhost` au lieu de l'API de production Mintlify, ce qui entraînait des erreurs de
    connexion ou un comportement inattendu.

    **Solution** : Mettez à jour vers la dernière version de la CLI :

    ```bash
    npm i -g mint@latest
    ```
  </Accordion>
</AccordionGroup>