Referencia de comandos de la CLI de Mintlify

Estos flags están disponibles en todos los comandos.

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

mint dev [flags]

Crea una nueva cuenta de Mintlify desde la terminal.

mint signup [flags]

Ejecuta el comando sin flags para introducir tus datos de forma interactiva. La CLI te pedirá cualquier valor que no pases como flag.

Después de enviar tus datos, Mintlify envía un enlace de verificación a tu correo electrónico. El comando espera hasta que haces clic en el enlace, luego crea tu cuenta, inicia sesión y almacena tus credenciales. Cuando termina, abre el panel de control para conectar tu repositorio y empezar a construir.

# Registro interactivo
mint signup

# Registro con todos los datos proporcionados
mint signup \
  --firstName Jane \
  --lastName Doe \
  --company Acme \
  --email jane@acme.com

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

Eliminar las credenciales almacenadas.

mint logout

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

Añade un dominio personalizado a tu implementación desde la terminal. Requiere autenticación con mint login.

mint add-domain <domain> [--basePath <path>]

El comando usa el subdominio configurado con mint config. Si no hay ninguno configurado, usa el primer subdominio de tu cuenta.

Una vez registrado el dominio, la CLI espera hasta 10 segundos a que se generen los registros DNS y luego imprime los registros TXT y CNAME que debes añadir en tu proveedor de dominio:

TXT _acme-challenge → <value>
TXT _cf-custom-hostname → <value>
CNAME @ → cname.mintlify.builders

Añade primero los registros TXT y, una vez validados, añade el CNAME. Consulta Dominio personalizado para ver las instrucciones completas de configuración de DNS, los requisitos para dominios apex y los detalles del aprovisionamiento de TLS.

Cuando pasas --basePath, la CLI guarda el base path después de registrar el dominio. El nuevo path se aplica en tu próximo despliegue, y tu sitio sigue sirviéndose desde el path actual hasta entonces. El CNAME envía todo el tráfico del dominio a Mintlify, así que solo añádelo si el dominio no aloja nada más. En caso contrario, mantén tu DNS actual y configura un reverse proxy a Mintlify para el base path. Consulta Hospedar la documentación en un subpath para ver guías por proveedor.

Ejemplos

Añade un dominio personalizado en la raíz:

mint add-domain docs.example.com

Añade un dominio personalizado y sirve tu documentación en /docs:

mint add-domain example.com --basePath /docs

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

mint automations <subcommand> [flags]

Todos los subcomandos aceptan estos flags compartidos:

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.

Crea una nueva automatización. Puedes pasar la definición de la automatización en línea con flags, o apuntar a un archivo JSON o YAML con --file.

mint automations create [flags]

Proporciona exactamente un trigger: pasa --cron para una automatización programada o uno o más flags --push-repo para una automatización activada por push.

# Automatización de traducciones programada
mint automations create \
  --name "Translate content" \
  --type translations \
  --cron "0 6 * * *"

# Automatización activada por push con contexto adicional
mint automations 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 automations create --file automation.yaml

Un archivo de automatización 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

Lista las automatizaciones del despliegue actual.

mint automations list [flags]

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

Elimina una automatización por ID. Usa mint automations list para obtener el ID.

mint automations delete <id> [flags]

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]

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.

Usa --files para limitar la verificación a páginas específicas. Es útil para validar una sola página que acabas de editar o para acotar las verificaciones a un directorio en CI. Cuando se combina --files con --check-external, solo se comprueban las URLs externas de las páginas seleccionadas.

# Verificar una página específica
mint broken-links --files introduction.mdx

# Verificar páginas que coincidan con un glob
mint broken-links --files "guides/**/*.mdx"

# Pasar varias rutas
mint broken-links --files introduction.mdx --files "guides/**/*.mdx"

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.

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]

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

mint export [flags]

Consulta Exportación offline para más detalles.

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]

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

# Evaluar tu subdominio por defecto
mint score

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

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

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.

Comprueba las páginas de documentación para detectar prosa que suena a IA y obtén sugerencias de reescritura. Requiere autenticación con mint login.

mint deslop [files...] [flags]

Para cada página marcada, el comando informa la fracción escrita por IA, los pasajes específicos que se detectan como generados por IA con sus números de línea, y sugerencias de reescritura en estilo humano.

Cada página comprobada consume un crédito de IA. Las páginas con menos de 50 palabras se omiten y no se cobran. Si alguna página alcanza el umbral o lo supera, o si una comprobación devuelve un error, el comando termina con el código 1. Si todas las páginas están limpias, el comando termina con el código 0. Esto te permite ejecutarlo en un bucle de reescritura o en CI.

# Comprobar las páginas modificadas en tu directorio de trabajo
mint deslop

# Comprobar una página específica
mint deslop docs/guide.mdx

# Comprobar todas las páginas MDX y emitir JSON para scripting
mint deslop "docs/**/*.mdx" --format json

# Además, limpiar los espacios en blanco en los archivos comprobados
mint deslop docs/guide.mdx --fix-whitespace

Formatea todos los archivos .mdx del directorio actual siguiendo el estilo canónico de Mintlify. El comando analiza cada archivo con el mismo analizador MDX que utiliza el editor web y luego lo reescribe in situ si la salida canónica difiere.

mint format

Ejecuta el comando desde la raíz de tu proyecto de documentación. Recorre cada subdirectorio, omitiendo las rutas que coincidan con .gitignore y cualquier regla de exclusión de Mintlify. Los archivos que ya coincidan con la salida canónica se dejan intactos.

Cuando termina, el comando muestra cuántos archivos MDX se reformatearon y cuántos no se pudieron analizar. Si algún archivo falla, el comando termina con el código 1 e imprime la ruta del archivo y el error, de modo que puedas ejecutarlo en CI para exigir un formato coherente.

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

mint new [directory] [flags]

Actualiza la CLI a la última versión.

mint update

Muestra las versiones actuales de la CLI y del cliente.

mint version

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.

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:

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