Comandos

Flags globales

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`.

`mint dev`

Inicia una previsualización local de tu documentación.

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.

Autenticarse con tu cuenta de Mintlify.

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>.

`mint logout`

Eliminar las credenciales almacenadas.

mint logout

`mint status`

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.

mint status

`mint analytics`

Consulta datos de analítica de tu documentación. Requiere autenticación con mint login.

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`.

`mint analytics stats`

Muestra un resumen de visitas, visitantes, búsquedas, comentarios y uso del asistente.

mint analytics stats [flags]

Flag	Descripción
`--page`	Filtrar por una ruta de página específica.

`mint analytics search`

Muestra consultas de búsqueda con recuento de resultados y tasas de clics.

mint analytics search [flags]

Flag	Descripción
`--query`	Filtrar por subcadena de consulta de búsqueda.
`--page`	Filtrar por página más clicada.

`mint analytics feedback`

Muestra los comentarios enviados por los usuarios.

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.

`mint analytics conversation`

Consulta datos de conversaciones del asistente.

mint analytics conversation <subcommand> [flags]

`mint analytics conversation list`

Lista las conversaciones del asistente. Cada entrada incluye un ID de conversación.

mint analytics conversation list [flags]

Flag	Descripción
`--page`	Filtrar conversaciones que hacen referencia a una página específica en las fuentes.

`mint analytics conversation view <conversation-id>`

Ver una conversación individual por ID. Usa mint analytics conversation list para obtener los IDs.

mint analytics conversation view <conversation-id>

`mint analytics conversation buckets list`

Lista las categorías agrupadas de conversaciones. Cada entrada incluye un ID de categoría.

mint analytics conversation buckets list

`mint analytics conversation buckets view <bucket-id>`

Ver las conversaciones en una categoría. Usa mint analytics conversation buckets list para obtener los IDs.

mint analytics conversation buckets view <bucket-id>

`mint workflow`

Crea, lista y elimina workflows desde la terminal. Requiere autenticación con mint login.

mint workflow <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.
`--format`	Formato de salida: `table` (por defecto, en formato legible) o `json` (sin procesar, legible por máquinas).

Cuando se establece --format json, los errores se imprimen en stderr como Error: <message> y el comando sale con un estado distinto de cero, para que puedas canalizar la salida exitosa a otras herramientas.

`mint workflow create`

Crea un nuevo workflow. Puedes pasar la definición del workflow en línea con flags, o apuntar a un archivo JSON o YAML con --file.

mint workflow create [flags]

Flag	Descripción
`--name`	Nombre del workflow. Obligatorio salvo que se proporcione `--file`.
`--prompt`	Instrucciones que se añaden al prompt base del workflow en cada ejecución.
`--type`	Tipo de workflow. Uno de `changelog`, `source-code-agent`, `translations`, `writing-style`, `typo-check`, `broken-link-detection`, `seo-metadata-audit`, `assistant-docs-updates` o `contextual-feedback-docs-updates`. Omítelo para un workflow personalizado.
`--cron`	Expresión cron para un trigger programado. Mutuamente excluyente con `--push-repo`.
`--push-repo`	Repositorio (`owner/repo`) para un trigger de push. Repetible para escuchar varios repositorios. Mutuamente excluyente con `--cron`.
`--context-repo`	Repositorio de contexto adicional (`owner/repo`) que el agente lee cuando se ejecuta el workflow. Repetible, hasta 10 en total.
`--automerge`	Fusiona automáticamente las pull requests abiertas por este workflow. Consulta Configurar automerge para los requisitos de configuración.
`--file`	Ruta a un archivo JSON o YAML con el cuerpo completo del workflow. Anula los flags en línea.

Se requiere exactamente un trigger: pasa --cron para un workflow programado o uno o más flags --push-repo para un workflow activado por push.

Ejemplos

# Workflow de traducciones programado
mint workflow create \
  --name "Translate content" \
  --type translations \
  --cron "0 6 * * *"

# Workflow activado por push con contexto adicional
mint workflow create \
  --name "Sync API reference" \
  --type source-code-agent \
  --push-repo my-org/api \
  --context-repo my-org/shared-types \
  --automerge

# Crear desde un archivo
mint workflow create --file workflow.yaml

Un archivo de workflow usa la misma forma que los flags en línea. El campo on contiene el trigger:

name: Translate content
type: translations
on:
  cron: "0 6 * * *"
prompt: Prefer formal tone in French translations.
automerge: false
context:
  - repo: my-org/shared-content

`mint workflow list`

Lista los workflows del despliegue actual.

mint workflow list [flags]

La salida en formato tabla por defecto muestra el ID, nombre, tipo, trigger y estado de cada workflow. Usa --format json para obtener los objetos completos del workflow.

`mint workflow delete`

Elimina un workflow por ID. Usa mint workflow list para obtener el ID.

mint workflow delete <id> [flags]

Argumento	Descripción
`id`	ID del esquema del workflow que se va a eliminar.

`mint config`

Gestiona valores predeterminados persistentes para los comandos de la CLI. La configuración se guarda en ~/.config/mintlify/config.json.

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.

Claves de configuración

Clave	Descripción	Usado por
`subdomain`	Subdominio predeterminado de la documentación.	`mint analytics`, `mint workflow`
`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`

`mint broken-links`

Verifica enlaces rotos internos en tu documentación.

mint broken-links [flags]

El comando excluye los archivos que coinciden con los patrones de .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-redirects`	También verificar que los destinos de redirección en `docs.json` se resuelvan a rutas válidas.
`--check-snippets`	También verificar enlaces dentro de componentes `<Snippet>`.

Verifica problemas de accesibilidad en tu documentación.

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.

`mint validate`

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.

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.

El comando independiente mint openapi-check está obsoleto. Usa mint validate en su lugar.

`mint export`

Exporta tu documentación como un archivo zip autónomo para visualización y distribución sin conexión.

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 para más detalles.

`mint score`

Ejecuta verificaciones de preparación para agentes en un sitio de documentación público. Requiere autenticación con mint login.

mint score [url] [flags]

Argumento	Descripción
`url`	Opcional. URL del sitio de documentación que se va a comprobar. Si se omite, el comando evalúa tu subdominio configurado (de `mint config` o el subdominio asociado a tu cuenta con sesión iniciada).

Flag	Descripción
`--format`	Formato de salida: `table` (predeterminado, con colores), `plain` (TSV para redirección) o `json`.

El comando muestra una puntuación general de preparación y un desglose de verificaciones individuales con indicadores de aprobado/reprobado.

Ejemplos

# Evaluar tu subdominio por defecto
mint score

# Evaluar un sitio específico
mint score docs.example.com

Verificaciones

La puntuación evalúa las siguientes áreas:

Verificación	Qué comprueba
`llmsTxtExists`	Los agentes pueden acceder a un archivo llms.txt en la raíz del sitio.
`llmsTxtValid`	El archivo `llms.txt` sigue el formato esperado con encabezados, resumen en bloque de cita y enlaces Markdown.
`llmsTxtSize`	El archivo `llms.txt` está dentro del umbral de tamaño para que los agentes puedan consumirlo sin truncamiento.
`llmsTxtLinksResolve`	Los enlaces dentro de `llms.txt` apuntan a páginas activas.
`llmsTxtLinksMarkdown`	Los enlaces dentro de `llms.txt` usan sintaxis Markdown.
`llmsTxtDirective`	El archivo `llms.txt` contiene directivas de uso.
`llmsTxtFullExists`	Un archivo llms-full.txt está disponible para agentes que necesitan el contenido completo. Se ejecuta independientemente de `llmsTxtExists`.
`llmsTxtFullSize`	El archivo `llms-full.txt` tiene un tamaño razonable para que los agentes lo procesen.
`llmsTxtFullValid`	El archivo `llms-full.txt` contiene contenido válido con encabezados.
`llmsTxtFullLinksResolve`	Los enlaces dentro de `llms-full.txt` apuntan a páginas activas.
`skillMd`	Los agentes pueden acceder a un archivo skill.md para el uso de herramientas por agentes.
`contentNegotiationMarkdown`	El sitio devuelve Markdown cuando los agentes lo solicitan mediante negociación de contenido.
`contentNegotiationPlaintext`	El sitio devuelve texto plano cuando los agentes lo solicitan mediante negociación de contenido.
`mcpServerDiscoverable`	Los agentes pueden descubrir un servidor MCP para agentes basados en herramientas.
`mcpToolCount`	El servidor MCP expone al menos una herramienta.
`openApiSpec`	Hay una especificación OpenAPI o Swagger disponible en una ruta estándar.
`robotsTxtAllowsAI`	El archivo `robots.txt` no bloquea los rastreadores de IA.
`sitemapExists`	Hay un mapa del sitio disponible para el descubrimiento de páginas.
`structuredData`	La página principal contiene datos estructurados JSON-LD (`<script type="application/ld+json">`). Informa el número de bloques JSON-LD y los tipos de esquema encontrados.
`responseLatency`	El sitio responde en un tiempo aceptable para los agentes.

Algunas verificaciones solo se ejecutan si una verificación de la que dependen pasa. Si una verificación falla, ninguna de las verificaciones que dependen de ella se ejecuta. Fallan automáticamente. Por ejemplo, llmsTxtValid solo pasa si llmsTxtExists pasa primero. La puntuación general utiliza puntuación ponderada, por lo que las verificaciones de mayor impacto contribuyen más a su puntuación.

`mint new`

Crea un nuevo proyecto de documentación eligiendo un tema o clonando una plantilla predefinida del repositorio mintlify/templates.

mint new [directory] [flags]

Flag	Descripción
`--name`	Nombre del proyecto. La CLI lo solicita si no se proporciona en modo interactivo.
`--theme`	Tema 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.

`mint update`

Actualiza la CLI a la última versión.

mint update

`mint version`

Muestra las versiones actuales de la CLI y del cliente.

mint version

Próximamente

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.

Telemetría

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:

# 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.

Tu preferencia se guarda en ~/.config/mintlify/config.json y persiste entre sesiones de la CLI.

Primeros pasos

Organizar

Personalizar

Crear contenido

Documentar APIs

Desplegar

Optimizar

Flags globales

`mint dev`

`mint logout`

`mint status`

`mint analytics`

`mint analytics stats`

`mint analytics search`

`mint analytics feedback`

`mint analytics conversation`

`mint analytics conversation list`

`mint analytics conversation view <conversation-id>`

`mint analytics conversation buckets list`

`mint analytics conversation buckets view <bucket-id>`

`mint workflow`

`mint workflow create`

Ejemplos

`mint workflow list`

`mint workflow delete`

`mint config`

Claves de configuración

`mint broken-links`

`mint validate`

`mint export`

`mint score`

Ejemplos

Verificaciones

`mint new`

`mint update`

`mint version`

Próximamente

Telemetría

​Flags globales

​mint dev

​mint login

​mint logout

​mint status

​mint analytics

​mint analytics stats

​mint analytics search

​mint analytics feedback

​mint analytics conversation

​mint analytics conversation list

​mint analytics conversation view <conversation-id>

​mint analytics conversation buckets list

​mint analytics conversation buckets view <bucket-id>

​mint workflow

​mint workflow create

​Ejemplos

​mint workflow list

​mint workflow delete

​mint config

​Claves de configuración

​mint broken-links

​mint a11y

​mint validate

​mint export

​mint score

​Ejemplos

​Verificaciones

​mint new

​mint update

​mint version

​Próximamente

​Telemetría

Flags globales

`mint dev`

`mint login`

`mint logout`

`mint status`

`mint analytics`

`mint analytics stats`

`mint analytics search`

`mint analytics feedback`

`mint analytics conversation`

`mint analytics conversation list`

`mint analytics conversation view <conversation-id>`

`mint analytics conversation buckets list`

`mint analytics conversation buckets view <bucket-id>`

`mint workflow`

`mint workflow create`

Ejemplos

`mint workflow list`

`mint workflow delete`

`mint config`

Claves de configuración

`mint broken-links`

`mint a11y`

`mint validate`

`mint export`

`mint score`

Ejemplos

Verificaciones

`mint new`

`mint update`

`mint version`

Próximamente

Telemetría