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

# Instalar la CLI

> Instala la CLI de Mintlify para previsualizar la documentación localmente, probar cambios en tiempo real y detectar errores antes de desplegar.

<div id="prerequisites">
  ## Requisitos previos
</div>

* [Node.js](https://nodejs.org/en) v20.17.0+ (se recomiendan versiones LTS)

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

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

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

<Tip>
  ¿Usas una herramienta de codificación con IA? Copia el siguiente prompt para que tu agente instale la CLI y verifique que funciona.
</Tip>

<Prompt description="Instala la CLI de Mintlify de forma global y verifica la instalación." actions={["copy", "cursor"]}>
  Instala la CLI de Mintlify de forma global para que pueda previsualizar mi documentación localmente.

  1. Confirma que Node.js v20.17.0 o posterior está instalado ejecutando `node --version`. Si falta o es más antiguo, avísame antes de continuar.
  2. Instala la CLI con `npm i -g mint` (o `pnpm add -g mint` si uso pnpm).
  3. Verifica la instalación ejecutando `mint --version` y comparte el resultado.
  4. Si la instalación falla con un error de permisos, sugiere volver a ejecutarla con `sudo` y explica el trade-off.
</Prompt>

<div id="create-a-new-project">
  ## Crear un nuevo proyecto
</div>

Para crear un nuevo proyecto de documentación a partir de la plantilla inicial de Mintlify, ejecuta el siguiente comando:

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

<Prompt description="Genera la estructura de un nuevo proyecto de Mintlify." actions={["copy", "cursor"]}>
  Crea un nuevo proyecto de Mintlify en el workspace actual.

  1. Pídeme un nombre de proyecto y el tema (o plantilla) preferido si aún no te lo he dicho.
  2. Ejecuta `mint new <directory> --name <name> --theme <theme>` de forma no interactiva, sustituyendo los valores que te di. Si elegí una plantilla en su lugar, ejecuta `mint new <directory> --template <template-name>`.
  3. Una vez que termine el comando, lista los archivos generados y destaca `docs.json` como el punto de entrada principal de configuración.
  4. Ejecuta `mint dev` desde el nuevo directorio y comparte la URL de la vista previa local.
</Prompt>

Si no especificas un directorio, la CLI te solicitará crear un nuevo subdirectorio o sobrescribir el directorio actual.

<Warning>
  Sobrescribir el directorio actual elimina todos los archivos existentes.
</Warning>

| Flag         | Descripción                                                                         |
| ------------ | ----------------------------------------------------------------------------------- |
| `--name`     | Nombre del proyecto. La CLI lo solicita si no se proporciona.                       |
| `--theme`    | [Tema](/es/customize/themes) del proyecto. La CLI lo solicita si no se proporciona. |
| `--template` | Plantilla predefinida. La CLI la solicita si no se proporciona.                     |
| `--force`    | Sobrescribir el directorio actual sin solicitar confirmación.                       |

En modo interactivo, la CLI pregunta si deseas elegir un tema o clonar una plantilla. Para omitir el aviso, pasa el flag `--template` directamente:

```bash theme={null}
mint new my-docs --template <template-name>
```

Puedes combinar `--template` con `--theme` para anular el tema predeterminado de la plantilla:

```bash theme={null}
mint new my-docs --template <template-name> --theme <theme>
```

Consulta las plantillas disponibles en el repositorio [mintlify/templates](https://github.com/mintlify/templates) en GitHub. En modo interactivo, la CLI obtiene y muestra las plantillas disponibles automáticamente.

En entornos no interactivos como pipelines de CI/CD o agentes de codificación IA, debes proporcionar los flags `--name` y `--theme`, o el flag `--template`.

<div id="update">
  ## Actualizar
</div>

Si tu previsualización local no está sincronizada con la documentación desplegada, actualiza la CLI a la última versión:

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

Si `mint update` no está disponible en tu versión, reinstala la CLI con la última versión:

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

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

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

Para resaltado de sintaxis y formato de código en archivos MDX, recomendamos usar las siguientes extensiones:

* **Cursor, Devin Desktop, VS Code**: [Extensión MDX para VS Code](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) y [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
* **JetBrains**: [Plugin MDX para IntelliJ IDEA](https://plugins.jetbrains.com/plugin/14944-mdx) y [Prettier](https://prettier.io/docs/webstorm)

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

<AccordionGroup>
  <Accordion title="Error: Could not load the &#x22;sharp&#x22; module using the darwin-arm64 runtime">
    Esto puede deberse a una versión desactualizada de Node.js. Intenta lo siguiente:

    1. Elimina la versión actual de la CLI de mint: `npm uninstall -g mint`
    2. Actualiza a Node.js v20.17.0+.
    3. Reinstala la CLI de mint: `npm install -g mint`
  </Accordion>

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

  <Accordion title="Error: permission denied">
    Esto se debe a que no tienes los permisos necesarios para instalar paquetes de Node de forma global.

    **Solución**: Intenta ejecutar `sudo npm i -g mint`. Cuando se te solicite, ingresa la contraseña que usas para desbloquear tu computadora.
  </Accordion>

  <Accordion title="La previsualización local no se ve igual que la documentación en la web">
    Es probable que esto se deba a una versión desactualizada de la CLI.

    **Solución**: Ejecuta `mint update` para obtener los últimos cambios.
  </Accordion>

  <Accordion title="Paquete mintlify versus mint">
    Si tienes problemas con el paquete de la CLI, primero ejecuta `npm ls -g` para ver qué paquetes están instalados globalmente. Si no usas npm, prueba `which mint` para localizar la instalación.

    Si tienes instalados tanto el paquete `mint` como el paquete `mintlify`, desinstala `mintlify`:

    ```bash theme={null}
    npm uninstall -g mintlify
    npm cache clean --force
    npm i -g mint
    ```
  </Accordion>

  <Accordion title="La versión del cliente muestra 'none' después de la instalación">
    Si ejecutas `mint version` y la versión del cliente se muestra como `none`, es posible que la CLI no pueda descargar la aplicación cliente debido a un firewall corporativo o VPN.

    **Solución**: Pide a tu administrador de TI que agregue `releases.mintlify.com` a la lista de permitidos de tu red.
  </Accordion>

  <Accordion title="La CLI se conecta a localhost en lugar de a producción al usar npx">
    En versiones anteriores a `4.0.1125`, ejecutar `npx mint dev` u otros comandos desde un
    repositorio de documentación podía hacer que la CLI se detectara incorrectamente como una
    compilación de desarrollo local. Esto provocaba que la CLI apuntara a URLs de `localhost` en
    lugar de a la API de producción de Mintlify, lo que generaba errores de conexión o
    comportamientos inesperados.

    **Solución**: Actualiza a la última versión de la CLI:

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