> ## Documentation Index
> Fetch the complete documentation index at: https://wiki.another-horizon.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Installer la CLI

> Utilisez la CLI pour prévisualiser la documentation en local, tester les modifications en temps réel et détecter les problèmes avant de déployer votre site de documentation.

<img className="block dark:hidden my-0 pointer-events-none" src="https://mintcdn.com/anotherhorizon/nGGkQ8HPtMLIJ_OO/images/installation/local-development-light.png?fit=max&auto=format&n=nGGkQ8HPtMLIJ_OO&q=85&s=923b23e1a0c8f22009b1876dc3dee86d" alt="Graphique décoratif représentant la CLI." 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/anotherhorizon/nGGkQ8HPtMLIJ_OO/images/installation/local-development-dark.png?fit=max&auto=format&n=nGGkQ8HPtMLIJ_OO&q=85&s=80ca9c1b30c8708c0057f439dc6e8434" alt="Graphique décoratif représentant la CLI." width="1184" height="320" data-path="images/installation/local-development-dark.png" />

Utilisez la [CLI](https://www.npmjs.com/package/mint) pour prévisualiser votre documentation en local pendant la rédaction et l’édition. Visualisez les changements en temps réel avant le déploiement, testez l’apparence et les fonctionnalités de votre site de documentation, et repérez les problèmes tels que les liens brisés ou les défauts d’accessibilité.

La CLI propose également des utilitaires pour maintenir votre documentation, notamment des commandes pour renommer des fichiers, valider des spécifications OpenAPI et migrer du contenu entre différents formats.

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

* [Node.js](https://nodejs.org/en) v20.17.0+ installé (versions LTS recommandées)
* [Git](https://git-scm.com/downloads) installé
* Votre référentiel de documentation cloné localement

<div id="clone-your-repository">
  ### Cloner votre référentiel
</div>

<Steps>
  <Step title="Repérer votre référentiel">
    1. Accédez à la page [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) de votre Dashboard.
    2. Notez l’emplacement de votre référentiel. Il s’agit de l’un des formats suivants :

    * `mintlify-community/docs-{org-name}-{id}` (référentiel hébergé par Mintlify)
    * `your-org/your-repo` (votre propre référentiel GitHub)
  </Step>

  <Step title="Cloner votre référentiel">
    <Tabs>
      <Tab title="Votre propre référentiel">
        Remplacez `your-org/your-repo` par les informations de votre référentiel indiquées dans [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings).

        ```bash theme={null}
        git clone https://github.com/your-org/your-repo
        cd your-repo
        ```

        <Tip>
          **GitHub App requise.** Pour activer les déploiements automatiques lorsque vous envoyez des modifications (push), vous devez installer la GitHub App. Consultez [GitHub](/fr/deploy/github) pour plus d’informations.
        </Tip>
      </Tab>

      <Tab title="Référentiel hébergé par Mintlify">
        Vous pouvez cloner votre référentiel sous forme de référentiel privé ou public. Les référentiels publics sont visibles par toute personne qui accède à l’URL du référentiel. Les référentiels privés sont visibles uniquement par les personnes de votre organisation.

        Sur la page [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) de votre Dashboard, sélectionnez **Clone as private** ou **Clone as public**.
      </Tab>
    </Tabs>
  </Step>
</Steps>

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

Exécutez la commande suivante pour installer le CLI :

<CodeGroup>
  ```bash npm theme={null}
  npm i -g mint
  ```

  ```bash pnpm theme={null}
  pnpm add -g mint
  ```
</CodeGroup>

<div id="preview-locally">
  ## Aperçu local
</div>

Rendez-vous dans votre répertoire de documentation contenant votre fichier `docs.json`, puis exécutez :

```bash theme={null}
mint dev
```

Un aperçu local de votre documentation est disponible à l’adresse `http://localhost:3000`.

Sinon, si vous ne souhaitez pas installer l’interface en ligne de commande (CLI) globalement, vous pouvez exécuter un script ponctuel :

```bash theme={null}
npx mint dev
```

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

Par défaut, l’interface en ligne de commande (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 la commande suivante :

```bash theme={null}
mint dev --port 3333
```

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

```mdx theme={null}
Le port 3000 est déjà utilisé. Utilisation du port 3001 à la place.
```

<div id="skip-openapi-processing">
  ## Ignorer le traitement OpenAPI
</div>

Si vous avez beaucoup de fichiers OpenAPI, vous pouvez ignorer leur traitement lors du développement local pour améliorer les performances en utilisant l’option `--disable-openapi` :

```bash theme={null}
mint dev --disable-openapi
```

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

Si vous utilisez une authentification partielle pour restreindre l’accès à votre documentation, vous pouvez prévisualiser en tant que groupe d’authentification spécifique en utilisant l’option `--groups [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 theme={null}
mint dev --groups admin
```

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

Pour créer un nouveau projet de documentation, exécutez la commande suivante :

```bash theme={null}
mint new [directory]
```

Cette commande clone le [kit de démarrage](https://github.com/mintlify/starter) dans un répertoire donné. Si aucun répertoire n’est précisé, l’interface en ligne de commande (CLI) vous propose de créer un nouveau sous-dossier ou d’écraser le répertoire actuel.

<Warning>
  L’écrasement du répertoire actuel supprime tous les fichiers existants.
</Warning>

L’outil CLI vous demande un nom de projet et un [thème](/fr/customize/themes) pour finaliser la configuration de votre projet.

Vous pouvez exécuter `mint new` avec les options suivantes :

* `--theme` : définir le thème du nouveau projet.
* `--name` : définir le nom du nouveau projet.
* `--force` : écraser le répertoire actuel s’il existe déjà.

Par exemple, pour créer un nouveau projet dans le répertoire `docs` avec le nom `my-project` et le thème `linden`, exécutez la commande suivante :

```bash theme={null}
mint new docs --name my-project --theme linden
```

<div id="update-the-cli">
  ## Mettre à jour l’interface en ligne de commande (CLI)
</div>

Si votre aperçu local n’est pas en phase avec ce que vous voyez sur le Web dans la version de production, mettez à jour votre CLI locale :

```bash theme={null}
mint update
```

Si la commande « mint update » n’est pas disponible dans votre version locale, réinstallez l’interface en ligne de commande (CLI) avec la dernière version :

<CodeGroup>
  ```bash npm theme={null}
  npm i -g mint@latest
  ```

  ```bash pnpm theme={null}
  pnpm add -g mint@latest
  ```
</CodeGroup>

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

<div id="find-broken-links">
  ### Rechercher les liens brisés
</div>

Identifiez les liens internes brisés avec la commande suivante :

```bash theme={null}
mint broken-links
```

La commande ignore les fichiers correspondant aux modèles définis dans [.mintignore](/fr/organize/mintignore). Les liens qui pointent vers des fichiers ignorés sont signalés comme brisés.

<div id="find-accessibility-issues">
  ### Détecter les problèmes d’accessibilité
</div>

Testez les rapports de contraste des couleurs et recherchez les textes alternatifs manquants pour les images et les vidéos de votre documentation avec la commande suivante :

```bash theme={null}
mint a11y
```

Utilisez des options pour détecter des problèmes d’accessibilité spécifiques.

```bash theme={null}
# Check only for missing alt text
mint a11y --skip-contrast

# Vérifier uniquement les problèmes de contraste des couleurs
mint a11y --skip-alt-text
```

<div id="check-openapi-spec">
  ### Vérifier la spécification OpenAPI
</div>

Vérifiez votre fichier OpenAPI à la recherche d’erreurs avec la commande suivante :

```bash theme={null}
mint openapi-check <nom de fichier OpenAPI ou URL>
```

Passez 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="rename-files">
  ### Renommer des fichiers
</div>

Renommez les fichiers et mettez à jour toutes leurs références avec la commande suivante :

```bash theme={null}
mint rename <chemin/vers/ancien-nom-de-fichier> <chemin/vers/nouveau-nom-de-fichier>
```

<div id="migrate-mdx-endpoint-pages">
  ### Migrer les pages d’endpoints MDX
</div>

Migrez les pages d’endpoints MDX vers des pages générées automatiquement à partir de votre spécification OpenAPI avec la commande suivante :

```bash theme={null}
mint migrate-mdx
```

Cette commande convertit les pages MDX d’endpoint individuelles en pages générées automatiquement, telles que 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 [Migration depuis MDX](/fr/guides/migrating-from-mdx) pour plus de détails.

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

Lors du développement en local, nous recommandons d'utiliser des extensions pour votre IDE afin de reconnaître et de 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, et [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, ainsi que 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’environnement d’exécution darwin-arm64">
    Cela peut être dû à une version obsolète de Node. Essayez ce qui suit :

    1. Désinstallez la version actuellement installée de l’interface en ligne de commande (CLI) Mint : `npm uninstall -g mint`
    2. Mettez à jour vers Node.js.
    3. Réinstallez la 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 de nouveau `mint dev`.
  </Accordion>

  <Accordion title="Erreur : permission refusée">
    Cela est dû au fait que vous n’avez pas les autorisations nécessaires pour installer globalement des paquets Node.

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

  <Accordion title="L’aperçu local n’a pas le même rendu que ma documentation en ligne">
    Cela est probablement dû à une version obsolète de la CLI.

    **Solution :** Exécutez `mint update` pour récupérer les dernières modifications.
  </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 theme={null}
      npm uninstall -g mintlify
    ```

    2. Videz le cache npm :

    ```bash theme={null}
      npm cache clean --force
    ```

    3. Réinstallez le nouveau paquet :

    ```bash theme={null}
    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 sur `none`, il est probable que la CLI ne parvienne pas à télécharger l’application cliente en raison d’un pare-feu d’entreprise ou d’un VPN qui bloque le téléchargement.

    **Solution :** Demandez à votre administrateur informatique d’autoriser `releases.mintlify.com` (whitelist) afin d’activer le développement local avec la CLI.
  </Accordion>
</AccordionGroup>