mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
98996bc026
* Document --template flag for mint new command Generated-By: mintlify-agent * docs: clarify --template flag description --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
403 lines
11 KiB
Plaintext
403 lines
11 KiB
Plaintext
---
|
|
title: "Comandos"
|
|
description: "Referencia completa de todos los comandos y flags de la CLI de Mintlify."
|
|
keywords: ["CLI", "mint", "comandos", "flags", "referencia"]
|
|
---
|
|
|
|
<div id="global-flags">
|
|
## Flags globales
|
|
</div>
|
|
|
|
Estos flags están disponibles en todos los comandos.
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--telemetry`, `-t` | Habilitar o deshabilitar la telemetría anónima de uso. |
|
|
| `--help`, `-h` | Mostrar la ayuda del comando. |
|
|
| `--version`, `-v` | Mostrar la versión de la CLI. Alias de `mint version`. |
|
|
|
|
<div id="mint-dev">
|
|
## `mint dev`
|
|
</div>
|
|
|
|
Inicia una previsualización local de tu documentación.
|
|
|
|
```bash
|
|
mint dev [flags]
|
|
```
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--port` | Puerto para ejecutar la previsualización local. Por defecto `3000`. |
|
|
| `--no-open` | No abrir el navegador automáticamente. |
|
|
| `--groups` | Lista separada por comas de grupos de usuarios a simular para la previsualización. |
|
|
| `--disable-openapi` | Omitir el procesamiento de archivos OpenAPI para mejorar el rendimiento. |
|
|
| `--local-schema` | Permitir archivos OpenAPI alojados localmente servidos por HTTP. |
|
|
|
|
---
|
|
|
|
<div id="mint-login">
|
|
## `mint login`
|
|
</div>
|
|
|
|
Autenticarse con tu cuenta de Mintlify.
|
|
|
|
```bash
|
|
mint login
|
|
```
|
|
|
|
Abre una ventana del navegador para completar la autenticación. Si el navegador no se abre, la CLI muestra una URL para abrir manualmente y un campo para pegar el código de autorización. Las credenciales se guardan en `~/.config/mintlify/config.json`.
|
|
|
|
Si tienes más de un despliegue, la CLI te solicita que selecciones uno predeterminado después de iniciar sesión. Puedes cambiar el proyecto predeterminado más tarde con `mint config set subdomain <subdomain>`.
|
|
|
|
---
|
|
|
|
<div id="mint-logout">
|
|
## `mint logout`
|
|
</div>
|
|
|
|
Eliminar las credenciales almacenadas.
|
|
|
|
```bash
|
|
mint logout
|
|
```
|
|
|
|
---
|
|
|
|
<div id="mint-status">
|
|
## `mint status`
|
|
</div>
|
|
|
|
Muestra los detalles de tu sesión actual, incluyendo la versión de la CLI, el correo electrónico de la cuenta, la organización y el subdominio configurado.
|
|
|
|
```bash
|
|
mint status
|
|
```
|
|
|
|
---
|
|
|
|
<div id="mint-analytics">
|
|
## `mint analytics`
|
|
</div>
|
|
|
|
Consulta datos de analítica de tu documentación. Requiere autenticación con `mint login`.
|
|
|
|
```bash
|
|
mint analytics <subcommand> [flags]
|
|
```
|
|
|
|
Todos los subcomandos aceptan estos flags compartidos:
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--subdomain` | Subdominio de la documentación. Por defecto usa el valor establecido con `mint config set subdomain`, o el primer proyecto de tu cuenta. |
|
|
| `--from` | Fecha de inicio en formato `YYYY-MM-DD`. Por defecto 7 días atrás, o el valor establecido con `mint config set dateFrom`. |
|
|
| `--to` | Fecha de fin en formato `YYYY-MM-DD`. Por defecto hoy, o el valor establecido con `mint config set dateTo`. |
|
|
| `--format` | Formato de salida: `plain` (por defecto), `table`, `json` o `graph`. |
|
|
|
|
<div id="mint-analytics-stats">
|
|
### `mint analytics stats`
|
|
</div>
|
|
|
|
Muestra un resumen de visitas, visitantes, búsquedas, comentarios y uso del asistente.
|
|
|
|
```bash
|
|
mint analytics stats [flags]
|
|
```
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--page` | Filtrar por una ruta de página específica. |
|
|
|
|
<div id="mint-analytics-search">
|
|
### `mint analytics search`
|
|
</div>
|
|
|
|
Muestra consultas de búsqueda con recuento de resultados y tasas de clics.
|
|
|
|
```bash
|
|
mint analytics search [flags]
|
|
```
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--query` | Filtrar por subcadena de consulta de búsqueda. |
|
|
| `--page` | Filtrar por página más clicada. |
|
|
|
|
<div id="mint-analytics-feedback">
|
|
### `mint analytics feedback`
|
|
</div>
|
|
|
|
Muestra los comentarios enviados por los usuarios.
|
|
|
|
```bash
|
|
mint analytics feedback [flags]
|
|
```
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--type` | Tipo de comentario: `page` (agregar por página) o `code` (comentarios de fragmentos de código). |
|
|
| `--page` | Filtrar por una ruta de página específica. |
|
|
|
|
<div id="mint-analytics-conversation">
|
|
### `mint analytics conversation`
|
|
</div>
|
|
|
|
Consulta datos de conversaciones del asistente.
|
|
|
|
```bash
|
|
mint analytics conversation <subcommand> [flags]
|
|
```
|
|
|
|
<div id="mint-analytics-conversation-list">
|
|
#### `mint analytics conversation list`
|
|
</div>
|
|
|
|
Lista las conversaciones del asistente. Cada entrada incluye un ID de conversación.
|
|
|
|
```bash
|
|
mint analytics conversation list [flags]
|
|
```
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--page` | Filtrar conversaciones que hacen referencia a una página específica en las fuentes. |
|
|
|
|
<div id="mint-analytics-conversation-view-conversation-id">
|
|
#### `mint analytics conversation view <conversation-id>`
|
|
</div>
|
|
|
|
Ver una conversación individual por ID. Usa `mint analytics conversation list` para obtener los IDs.
|
|
|
|
```bash
|
|
mint analytics conversation view <conversation-id>
|
|
```
|
|
|
|
<div id="mint-analytics-conversation-buckets-list">
|
|
#### `mint analytics conversation buckets list`
|
|
</div>
|
|
|
|
Lista las categorías agrupadas de conversaciones. Cada entrada incluye un ID de categoría.
|
|
|
|
```bash
|
|
mint analytics conversation buckets list
|
|
```
|
|
|
|
<div id="mint-analytics-conversation-buckets-view-bucket-id">
|
|
#### `mint analytics conversation buckets view <bucket-id>`
|
|
</div>
|
|
|
|
Ver las conversaciones en una categoría. Usa `mint analytics conversation buckets list` para obtener los IDs.
|
|
|
|
```bash
|
|
mint analytics conversation buckets view <bucket-id>
|
|
```
|
|
|
|
---
|
|
|
|
<div id="mint-config">
|
|
## `mint config`
|
|
</div>
|
|
|
|
Gestiona valores predeterminados persistentes para los comandos de la CLI. La configuración se guarda en `~/.config/mintlify/config.json`.
|
|
|
|
```bash
|
|
mint config <subcommand> <key> [value]
|
|
```
|
|
|
|
| Subcomando | Descripción |
|
|
| --- | --- |
|
|
| `set <key> <value>` | Establecer un valor de configuración. |
|
|
| `get <key>` | Mostrar un valor de configuración. |
|
|
| `clear <key>` | Eliminar un valor de configuración. |
|
|
|
|
<div id="configuration-keys">
|
|
### Claves de configuración
|
|
</div>
|
|
|
|
| Clave | Descripción | Usado por |
|
|
| --- | --- | --- |
|
|
| `subdomain` | Subdominio predeterminado de la documentación. | `mint analytics` |
|
|
| `dateFrom` | Fecha de inicio predeterminada para consultas de analítica (`YYYY-MM-DD`). | `mint analytics` |
|
|
| `dateTo` | Fecha de fin predeterminada para consultas de analítica (`YYYY-MM-DD`). | `mint analytics` |
|
|
|
|
---
|
|
|
|
<div id="mint-broken-links">
|
|
## `mint broken-links`
|
|
</div>
|
|
|
|
Verifica enlaces rotos internos en tu documentación.
|
|
|
|
```bash
|
|
mint broken-links [flags]
|
|
```
|
|
|
|
El comando excluye los archivos que coinciden con los patrones de [.mintignore](/es/organize/mintignore). Los enlaces que apuntan a archivos ignorados se reportan como rotos.
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--check-anchors` | También validar enlaces de ancla (por ejemplo, `/page#section`) contra los slugs de encabezados. |
|
|
| `--check-external` | También verificar URLs externas en busca de enlaces rotos. |
|
|
| `--check-snippets` | También verificar enlaces dentro de componentes `<Snippet>`. |
|
|
|
|
---
|
|
|
|
<div id="mint-a11y">
|
|
## `mint a11y`
|
|
</div>
|
|
|
|
Verifica problemas de accesibilidad en tu documentación.
|
|
|
|
```bash
|
|
mint a11y [flags]
|
|
```
|
|
|
|
Verifica las relaciones de contraste de color y la falta de texto alternativo en imágenes y videos.
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--skip-contrast` | Omitir las verificaciones de contraste de color. |
|
|
| `--skip-alt-text` | Omitir las verificaciones de texto alternativo faltante. |
|
|
|
|
---
|
|
|
|
<div id="mint-validate">
|
|
## `mint validate`
|
|
</div>
|
|
|
|
Valida la compilación de tu documentación en modo estricto. Finaliza con error si hay advertencias o errores. Incluye validación automática de las especificaciones OpenAPI referenciadas en tu `docs.json`.
|
|
|
|
```bash
|
|
mint validate [flags]
|
|
```
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--groups` | Lista separada por comas de grupos de usuarios a simular para la validación. |
|
|
| `--disable-openapi` | Omitir el procesamiento y validación de archivos OpenAPI. |
|
|
| `--local-schema` | Permitir la validación de archivos OpenAPI alojados localmente servidos por HTTP. Solo admite HTTPS en producción. |
|
|
|
|
<Note>
|
|
El comando independiente `mint openapi-check` está obsoleto. Usa `mint validate` en su lugar.
|
|
</Note>
|
|
|
|
---
|
|
|
|
<div id="mint-workflow">
|
|
## `mint workflow`
|
|
</div>
|
|
|
|
Crea un archivo de [flujo de trabajo](/es/agent/workflows) de forma interactiva.
|
|
|
|
```bash
|
|
mint workflow
|
|
```
|
|
|
|
La CLI solicita un nombre, tipo de activador y otros ajustes, luego crea un archivo `.md` en `.mintlify/workflows/`.
|
|
|
|
---
|
|
|
|
<div id="mint-export">
|
|
## `mint export`
|
|
</div>
|
|
|
|
Exporta tu documentación como un archivo zip autónomo para visualización y distribución sin conexión.
|
|
|
|
```bash
|
|
mint export [flags]
|
|
```
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--output` | Nombre del archivo de salida. Por defecto `export.zip`. |
|
|
| `--groups` | Lista separada por comas de grupos de usuarios para incluir páginas restringidas. |
|
|
| `--disable-openapi` | Omitir el procesamiento de OpenAPI. |
|
|
|
|
Consulta [Exportación offline](/es/deploy/export) para más detalles.
|
|
|
|
---
|
|
|
|
<div id="mint-new">
|
|
## `mint new`
|
|
</div>
|
|
|
|
Crea un nuevo proyecto de documentación a partir de la plantilla inicial de Mintlify o de una plantilla predefinida.
|
|
|
|
```bash
|
|
mint new [directory] [flags]
|
|
```
|
|
|
|
| Flag | Descripción |
|
|
| --- | --- |
|
|
| `--name` | Nombre del proyecto. La CLI lo solicita si no se proporciona en modo interactivo. |
|
|
| `--theme` | [Tema](/es/customize/themes) del proyecto. La CLI lo solicita si no se proporciona en modo interactivo. |
|
|
| `--template` | Plantilla predefinida. La CLI la solicita si no se proporciona en modo interactivo. |
|
|
| `--force` | Sobrescribir el directorio sin solicitar confirmación. |
|
|
|
|
---
|
|
|
|
<div id="mint-update">
|
|
## `mint update`
|
|
</div>
|
|
|
|
Actualiza la CLI a la última versión.
|
|
|
|
```bash
|
|
mint update
|
|
```
|
|
|
|
---
|
|
|
|
<div id="mint-version">
|
|
## `mint version`
|
|
</div>
|
|
|
|
Muestra las versiones actuales de la CLI y del cliente.
|
|
|
|
```bash
|
|
mint version
|
|
```
|
|
|
|
---
|
|
|
|
<div id="coming-soon">
|
|
## Próximamente
|
|
</div>
|
|
|
|
Estos comandos están disponibles para ejecutar pero aún no son funcionales. Ejecutarlos registra tu interés a través de la telemetría de la CLI y ayuda a priorizar qué se lanza a continuación.
|
|
|
|
| Comando | Descripción |
|
|
| --- | --- |
|
|
| `mint ai` | Herramientas de documentación con IA. |
|
|
| `mint test` | Pruebas de documentación. |
|
|
| `mint signup` | Registro de cuenta desde la CLI. |
|
|
| `mint mcp` | Servidor MCP para documentación. |
|
|
|
|
---
|
|
|
|
<div id="telemetry">
|
|
## Telemetría
|
|
</div>
|
|
|
|
La CLI recopila telemetría anónima de uso para ayudar a mejorar Mintlify. Los datos de telemetría incluyen el nombre del comando, la versión de la CLI, el sistema operativo y la arquitectura. Mintlify **no** recopila información de identificación personal, contenido del proyecto ni rutas de archivos.
|
|
|
|
Por defecto, la CLI recopila datos de telemetría. Puedes desactivarla en cualquier momento usando el flag `--telemetry`:
|
|
|
|
```bash
|
|
# Deshabilitar telemetría
|
|
mint --telemetry false
|
|
|
|
# Volver a habilitar telemetría
|
|
mint --telemetry true
|
|
```
|
|
|
|
También puedes deshabilitar la telemetría configurando una de estas variables de entorno:
|
|
|
|
| Variable | Valor | Descripción |
|
|
| --- | --- | --- |
|
|
| `MINTLIFY_TELEMETRY_DISABLED` | `1` | Deshabilitar la telemetría de la CLI de Mintlify. |
|
|
| `DO_NOT_TRACK` | `1` | Deshabilitar la telemetría usando el estándar [Console Do Not Track](https://consoledonottrack.com/). |
|
|
|
|
Tu preferencia se guarda en `~/.config/mintlify/config.json` y persiste entre sesiones de la CLI.
|