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

# Instalación de la CLI

> Instala la CLI para previsualizar y desarrollar tu documentación en local

<img className="block dark:hidden my-0 pointer-events-none" src="https://mintcdn.com/mintlify-mintlify-add-i-to-quickstart-8818/POxrbHB6_BZDU4E9/images/installation/local-development-light.png?fit=max&auto=format&n=POxrbHB6_BZDU4E9&q=85&s=e9d083cc9d42c71f948152ba1c232b1e" 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-i-to-quickstart-8818/POxrbHB6_BZDU4E9/images/installation/local-development-dark.png?fit=max&auto=format&n=POxrbHB6_BZDU4E9&q=85&s=cbeea80ed50dddc0d68ce6762f7baec7" width="1184" height="320" data-path="images/installation/local-development-dark.png" />

<div id="installing-the-cli">
  ## Instalación de la CLI
</div>

<Info>
  **Requisito previo**: Instala [Node.js](https://nodejs.org/en) antes de continuar.
</Info>

<Steps>
  <Step title="Instala la CLI.">
    Ejecuta el siguiente comando para instalar 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="Vista previa local.">
    Ve a tu directorio de docs (donde se encuentra el archivo `docs.json`) y ejecuta el siguiente comando:

    ```bash
    mint dev
    ```

    Una vista previa local de tu documentación estará disponible en `http://localhost:3000`.
  </Step>
</Steps>

Como alternativa, si no deseas instalar la CLI globalmente, puedes ejecutar un script de una sola vez:

```bash
npx mint dev
```

<div id="updates">
  ## Actualizaciones
</div>

Si tu vista previa local no coincide con lo que ves en la versión de producción en la web, actualiza tu CLI local:

```bash
mint update
```

Si el comando `mint update` no está disponible en tu versión local, reinstala la CLI con la versión más reciente:

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

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

<div id="custom-ports">
  ## Puertos personalizados
</div>

De forma predeterminada, la CLI utiliza el puerto 3000. Puedes personalizarlo con la opción `--port`. Para ejecutar la CLI en el puerto 3333, por ejemplo, usa este comando:

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

Si intentas ejecutar en un puerto que ya está en uso, se usará el siguiente puerto disponible:

```mdx
El puerto 3000 ya está en uso. Probando con el 3001.
```

<div id="previewing-as-a-specific-group">
  ## Previsualizar como un grupo específico
</div>

Si usas autenticación parcial para restringir el acceso a tu documentación, puedes previsualizar como un grupo de autenticación específico usando la opción `--group [groupname]`.

Por ejemplo, si tienes un grupo llamado `admin`, puedes previsualizar como miembro de ese grupo con el comando:

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

<div id="additional-commands">
  ## Comandos adicionales
</div>

Si bien `mint dev` es el comando más utilizado, hay otros comandos que puedes usar para administrar tu documentación.

<div id="finding-broken-links">
  ### Buscar enlaces rotos
</div>

La CLI puede ayudarte a validar los enlaces de referencia en tu documentación. Para identificar enlaces rotos, usa el siguiente comando:

```bash
mint broken-links
```

<div id="checking-openapi-spec">
  ### Comprobar la especificación de OpenAPI
</div>

Puedes usar la CLI para verificar tu archivo de OpenAPI en busca de errores con el siguiente comando:

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

Puedes proporcionar un nombre de archivo (por ejemplo, `./openapi.yaml`) o una URL (por ejemplo, `https://petstore3.swagger.io/api/v3/openapi.json`).

<div id="renaming-files">
  ### Cambiar el nombre de archivos
</div>

Puedes cambiar el nombre y actualizar todas las referencias a los archivos con el siguiente comando:

```bash
mint rename <nombreAnterior> <nombreNuevo>
```

<div id="migrating-mdx-endpoint-pages">
  ### Migrar páginas de endpoints en MDX
</div>

Puedes migrar páginas de endpoints en MDX a páginas generadas automáticamente a partir de tu especificación de OpenAPI con el siguiente comando:

```bash
mint migrate-mdx
```

Este comando convierte páginas individuales de endpoints en MDX en páginas autogeneradas definidas en tu `docs.json`, mueve el contenido MDX a la extensión `x-mint` de tu especificación OpenAPI y actualiza la navegación. Consulta [Migrating from MDX](/es/api-playground/migrating-from-mdx) para obtener información detallada.

<div id="formatting">
  ## Formato
</div>

Al desarrollar en local, recomendamos usar extensiones en tu IDE para reconocer y dar formato a archivos `MDX`.

Si usas Cursor, Windsurf o VS Code, recomendamos la [extensión MDX para VS Code](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) para el resaltado de sintaxis y [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) para el formateo de código.

Si usas JetBrains, recomendamos el [plugin MDX para IntelliJ IDEA](https://plugins.jetbrains.com/plugin/14944-mdx) para el resaltado de sintaxis y configurar [Prettier](https://prettier.io/docs/webstorm) para el formateo de código.

<div id="troubleshooting">
  ## Solución de problemas
</div>

<AccordionGroup>
  <Accordion title="Error: no se pudo cargar el módulo &#x22;sharp&#x22; usando el runtime darwin-arm64">
    Esto puede deberse a una versión desactualizada de Node. Prueba lo siguiente:

    1. Desinstala la versión actualmente instalada del CLI de mint: `npm uninstall -g mint`
    2. Actualiza a Node.js.
    3. Vuelve a instalar el CLI de mint: `npm install -g mint`
  </Accordion>

  <Accordion title="Problema: aparece un error desconocido">
    **Solución**: Ve al directorio raíz de tu usuario y elimina la carpeta `~/.mintlify`. Después, ejecuta `mint dev` nuevamente.
  </Accordion>

  <Accordion title="Error: permiso denegado">
    Esto ocurre por no tener los permisos necesarios para instalar paquetes de Node de forma global.

    **Solución**: Intenta ejecutar `sudo npm i -g mint`. Se te pedirá tu contraseña, la misma que usas para desbloquear tu computadora.
  </Accordion>

  <Accordion title="La vista previa local no se ve igual que mis docs en la web">
    Probablemente se deba a una versión desactualizada del CLI.

    **Solución:** Ejecuta `mint update` para obtener los cambios más recientes.
  </Accordion>

  <Accordion title="mintlify vs. paquete mint">
    Si tienes algún problema con el paquete del CLI, primero ejecuta `npm ls -g`. Este comando muestra qué paquetes están instalados globalmente en tu máquina.

    Si no usas npm o no lo ves en la lista con -g, prueba `which mint` para localizar la instalación.

    Si tienes un paquete llamado `mint` y otro llamado `mintlify` instalados, deberías desinstalar `mintlify`.

    1. Desinstala el paquete antiguo:

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

    2. Limpia la caché de npm:

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

    3. Vuelve a instalar el paquete nuevo:

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