> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-mintlify-add-hello-world-quickstart-48843.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation du CLI

> Installez le CLI pour prévisualiser et développer votre documentation localement

<img className="block dark:hidden my-0 pointer-events-none" src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/KAieJWDWb9msJsqT/images/installation/local-development-light.png?fit=max&auto=format&n=KAieJWDWb9msJsqT&q=85&s=0ccb2fa08cdb0ae4310b4d3be4a4a322" width="1184" height="320" data-path="images/installation/local-development-light.png" />

<img className="hidden dark:block my-0 pointer-events-none" src="https://mintcdn.com/mintlify-mintlify-add-hello-world-quickstart-48843/KAieJWDWb9msJsqT/images/installation/local-development-dark.png?fit=max&auto=format&n=KAieJWDWb9msJsqT&q=85&s=b612170c5a066bf7bdad08ba7df1ece8" width="1184" height="320" data-path="images/installation/local-development-dark.png" />

<div id="installing-the-cli">
  ## Installation de la CLI
</div>

<Info>
  **Prérequis** : Installez [Node.js](https://nodejs.org/en) avant de continuer.
</Info>

<Steps>
  <Step title="Installez la CLI.">
    Exécutez la commande suivante pour installer la [CLI](https://www.npmjs.com/package/mint) :

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

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

  <Step title="Prévisualisez en local.">
    Accédez à votre répertoire de documentation (où se trouve votre fichier `docs.json`) et exécutez la commande suivante :

    ```bash
    mint dev
    ```

    Un aperçu local de votre documentation sera disponible sur `http://localhost:3000`.
  </Step>
</Steps>

Sinon, si vous ne souhaitez pas installer la CLI globalement, vous pouvez exécuter un script ponctuel :

```bash
npx mint dev
```

<div id="updates">
  ## Mises à jour
</div>

Si votre aperçu local n’est pas synchronisé avec ce que vous voyez en production sur le Web, mettez à jour votre CLI local :

```bash
mint update
```

Si la commande `mint update` n’est pas disponible dans votre environnement local, réinstallez le CLI avec la dernière version :

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

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

<div id="custom-ports">
  ## Ports personnalisés
</div>

Par défaut, la CLI utilise le port 3000. Vous pouvez définir le port avec l’option `--port`. Pour exécuter la CLI sur le port 3333, par exemple, utilisez cette commande :

```bash
mint dev --port 3333
```

Si vous tentez d’exécuter sur un port déjà utilisé, il utilisera le prochain port disponible :

```mdx
Le port 3000 est déjà utilisé. Tentative sur le port 3001.
```

<div id="previewing-as-a-specific-group">
  ## Prévisualiser en tant que groupe spécifique
</div>

Si vous utilisez l'authentification partielle pour restreindre l'accès à votre documentation, vous pouvez prévisualiser en tant que groupe d'authentification spécifique avec l'option `--group [groupname]`.

Par exemple, si vous avez un groupe nommé `admin`, vous pouvez prévisualiser en tant que membre de ce groupe avec la commande :

```bash
mint dev --group admin
```

<div id="additional-commands">
  ## Commandes supplémentaires
</div>

Bien que `mint dev` soit la commande la plus utilisée, d’autres commandes permettent également de gérer votre documentation.

<div id="finding-broken-links">
  ### Détection des liens cassés
</div>

La CLI peut vous aider à valider les liens de référence présents dans votre documentation. Pour repérer les liens cassés, utilisez la commande suivante :

```bash
mint broken-links
```

<div id="checking-openapi-spec">
  ### Vérification de la spécification OpenAPI
</div>

Vous pouvez utiliser l’interface en ligne de commande (CLI) pour vérifier les erreurs de votre fichier OpenAPI avec la commande suivante :

```bash
mint openapi-check <nomFichierOuUrlOpenAPI>
```

Vous pouvez fournir un nom de fichier (par exemple « ./openapi.yaml ») ou une URL (par exemple « [https://petstore3.swagger.io/api/v3/openapi.json](https://petstore3.swagger.io/api/v3/openapi.json) »).

<div id="renaming-files">
  ### Renommer des fichiers
</div>

Vous pouvez renommer des fichiers et mettre à jour toutes les références à ces fichiers à l’aide de la commande suivante :

```bash
mint rename <ancienNomDeFichier> <nouveauNomDeFichier>
```

<div id="migrating-mdx-endpoint-pages">
  ### Migration des pages d’endpoint MDX
</div>

Vous pouvez migrer des pages d’endpoint MDX vers des pages générées automatiquement à partir de votre spécification OpenAPI à l’aide de la commande suivante :

```bash
mint migrate-mdx
```

Cette commande convertit les pages d’endpoints MDX individuelles en pages générées automatiquement définies dans votre `docs.json`, déplace le contenu MDX vers l’extension `x-mint` de votre spécification OpenAPI et met à jour votre navigation. Consultez [Migrating from MDX](/fr/api-playground/migrating-from-mdx) pour plus de détails.

<div id="formatting">
  ## Mise en forme
</div>

En développement local, nous recommandons d’utiliser des extensions dans votre IDE pour reconnaître et formater les fichiers `MDX`.

Si vous utilisez Cursor, Windsurf ou VS Code, nous recommandons l’[extension MDX pour VS Code](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) pour la coloration syntaxique, ainsi que [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) pour le formatage du code.

Si vous utilisez JetBrains, nous recommandons le [plugin MDX pour IntelliJ IDEA](https://plugins.jetbrains.com/plugin/14944-mdx) pour la coloration syntaxique, et la configuration de [Prettier](https://prettier.io/docs/webstorm) pour le formatage du code.

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

<AccordionGroup>
  <Accordion title="Erreur : impossible de charger le module &#x22;sharp&#x22; avec l’exécution darwin-arm64">
    Cela peut être dû à une version obsolète de Node.js. Essayez ce qui suit :

    1. Désinstallez la version actuellement installée du CLI mint : `npm uninstall -g mint`
    2. Mettez à niveau vers Node.js.
    3. Réinstallez le CLI mint : `npm install -g mint`
  </Accordion>

  <Accordion title="Problème : erreur inconnue">
    **Solution** : Accédez à la racine de votre appareil et supprimez le dossier `~/.mintlify`. Ensuite, exécutez à nouveau `mint dev`.
  </Accordion>

  <Accordion title="Erreur : permission refusée">
    Cela est dû à l’absence des autorisations requises pour installer des paquets Node.js globalement.

    **Solution** : Essayez d’exécuter `sudo npm i -g mint`. Il vous sera demandé votre mot de passe, celui que vous utilisez pour déverrouiller votre ordinateur.
  </Accordion>

  <Accordion title="L’aperçu local n’a pas le même rendu que mes docs sur le web">
    Cela est probablement dû à une version obsolète du CLI.

    **Solution :** Exécutez `mint update` pour récupérer les dernières mises à jour.
  </Accordion>

  <Accordion title="mintlify vs paquet mint">
    Si vous rencontrez des problèmes avec le paquet CLI, commencez par exécuter `npm ls -g`. Cette commande affiche les paquets installés globalement sur votre machine.

    Si vous n’utilisez pas npm ou ne le voyez pas dans la liste -g, essayez `which mint` pour localiser l’installation.

    Si vous avez un paquet nommé `mint` et un paquet nommé `mintlify` installés, vous devez désinstaller `mintlify`.

    1. Désinstallez l’ancien paquet :

    ```bash
      npm uninstall -g mintlify
    ```

    2. Videz le cache npm :

    ```bash
      npm cache clean --force
    ```

    3. Réinstallez le nouveau paquet :

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