Saltar al contenido principal
Para instalar la CLI, consulta Instalar la CLI.

Flags globales

Estos flags están disponibles en todos los comandos.

mint dev

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

mint signup

Crea una nueva cuenta de Mintlify desde una terminal interactiva.
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.
mint signup no finaliza hasta que hagas clic en el enlace de verificación, lo que puede tardar varios minutos.Cuando un agente de IA ejecuta mint signup, o el comando se ejecuta sin una terminal interactiva, muestra la guía de registro para agentes en lugar de crear una cuenta. Los agentes crean sitios sin una cuenta mediante el registro de agentes.

Ejemplos


mint deploy

Crea un sitio sin una cuenta y obtén acceso de push de Git a él. Para ver el flujo completo, consulta Registro de agentes.
Vuelve a ejecutar el comando desde el mismo directorio para obtener un nuevo token de escritura para el mismo sitio. En GitHub Actions, mint deploy hace push del commit extraído a un sitio que confía en el repositorio. El flujo de trabajo necesita el permiso id-token: write.

Ejemplos


mint claim

Reclama un sitio creado con mint deploy.
Ejecuta mint claim para obtener un enlace de reclamación. El propietario del sitio lo abre, inicia sesión con cualquier cuenta y hace clic en Confirm; el sitio se traslada a una nueva organización en su cuenta. --email y --code no se pueden combinar.

Ejemplos


mint login

Autenticarse con tu cuenta de Mintlify.
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. La CLI almacena tus credenciales en el almacén de credenciales de tu sistema operativo, como Keychain en macOS. Si tienes más de un proyecto, 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 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 add-domain

Añade un dominio personalizado a tu proyecto desde la terminal. Requiere autenticación con mint login.
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:
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. Si el comando falla con Domain is already in use by another deployment in your organization o Domain is already claimed by another organization, el dominio está vinculado a otro proyecto de Mintlify. Consulta Al añadir un dominio aparece el error “Domain is already claimed by another organization” para liberarlo y volver a añadirlo.
Si algunos registros TXT aún se están generando cuando el comando finaliza, revisa la página de Configuración de dominio personalizado en tu panel para ver los valores restantes.
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:
Añade un dominio personalizado y sirve tu documentación en /docs:

mint analytics

Consulta las analíticas de la documentación desde la terminal. Requiere autenticación con mint login.
Las analíticas requieren un plan Pro o Enterprise.
Todos los subcomandos aceptan estos flags compartidos:

mint analytics stats

Muestra los KPIs principales para un rango de fechas: vistas, visitantes, búsquedas, feedback y uso del asistente. El tráfico humano y el de agentes se reportan por separado.
Muestra las consultas de búsqueda con el número de resultados, la tasa de clics, la página más clicada y la fecha de la última búsqueda.

mint analytics feedback

Muestra el feedback enviado por los usuarios. Por defecto, devuelve entradas individuales de feedback. Pasa --type page para ver el feedback agregado por ruta de página, o --type code para incluir solo el feedback sobre fragmentos de código.

mint analytics conversation

Consulta las analíticas de las conversaciones del asistente.

mint analytics conversation list

Lista las conversaciones recientes del asistente con marca de tiempo, primera consulta del usuario y categoría.

mint analytics conversation view

Consulta el hilo completo de mensajes de una sola conversación.

mint analytics conversation buckets list

Lista los clústeres de conversaciones agrupadas por tema, con el número de conversaciones y la fecha de la pregunta más reciente para cada clúster.

mint analytics conversation buckets view

Lista los hilos individuales de un bucket de conversaciones.

Ejemplos


mint agent setup

Configura agentes de programación con IA para trabajar en tu proyecto de Mintlify. El comando instala las skills de Mintlify y configura el Admin MCP para Claude Code, Codex o Cursor.
mint agent setup requiere Node.js 22.20 o posterior y npm. La CLI no funciona en Node.js 25.
Sin una terminal interactiva, el comando configura los agentes que detecta. Si no detecta ninguno, pasa --agent. El comando agrega un servidor MCP llamado mintlify con la URL https://mcp.mintlify.com al archivo de configuración de cada agente. Si tu configuración de Codex define mcp_servers como una tabla en línea, la configuración no puede agregarle una entrada y se detiene con un error. Agrega tú mismo una entrada mintlify con url = "https://mcp.mintlify.com" a la tabla en línea. Si CLAUDE_CONFIG_DIR está definido, la configuración con --global para Claude Code se detiene con un error. En su lugar, agrega el servidor con la CLI de Claude Code:
La configuración conserva tu configuración existente y omite cualquier agente que ya tenga una entrada mintlify coincidente. Si una entrada mintlify tiene una configuración diferente, o no se puede analizar un archivo de configuración, la configuración se detiene antes de instalar las skills. Cambia el nombre de la entrada en conflicto o elimínala y vuelve a ejecutar el comando. La configuración solo busca una entrada llamada mintlify. Si un agente ya se conecta al Admin MCP con otro nombre, como mintlify-admin, la configuración agrega una segunda entrada. Elimina una de ellas para que el agente no se conecte dos veces al Admin MCP. Volver a ejecutar el comando actualiza las skills instaladas y reemplaza cualquier edición local que hayas hecho en ellas. El comando no inicia tu sesión en el Admin MCP ni reutiliza tus credenciales de mint login. Después de la configuración, completa el inicio de sesión OAuth en cada agente. El comando muestra los pasos para cada agente que configuraste.

Ejemplos


mint instructions

Muestra instrucciones paso a paso para una tarea en Mintlify, escritas para agentes de programación con IA. Cada tema cubre una tarea común, como publicar un sitio nuevo o agregar un dominio personalizado. Enumera los pasos, las reglas que los agentes suelen equivocar y cómo verificar el resultado. Tu agente puede ejecutar el comando antes de empezar una tarea en lugar de depender de sus datos de entrenamiento. La CLI obtiene cada tema de la documentación de Mintlify en vivo, por lo que las instrucciones se mantienen actualizadas sin necesidad de actualizar la CLI.
Sin un tema, el comando enumera los temas disponibles y cuándo usar cada uno. Con un tema, muestra las instrucciones de ese tema en Markdown. Empieza con overview. El comando necesita conexión a internet. Si un tema no existe, el comando termina con un error. Ejecuta mint instructions para ver los temas válidos. Si tu CLI instalada no reconoce el comando, ejecuta mint update o usa npx mint@latest instructions.

Ejemplos


mint config

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

Claves de configuración


Verifica enlaces rotos internos en tu documentación.
El comando analiza los archivos .mdx y .md en busca de enlaces y excluye los archivos que coinciden con los patrones de .mintignore. No se verifican los enlaces dentro de archivos de especificación OpenAPI (.yaml, .yml, .json). Los enlaces que apuntan a archivos ignorados se reportan como rotos. El comando verifica los enlaces e imágenes de Markdown, incluidos los enlaces de estilo referencia como [text][id]. También verifica el href de los componentes <a> y <Card> y el src de las etiquetas <img> y <source>, ya sea que estén escritos como una cadena simple o como un valor fijo entre llaves, como href={"/quickstart"}. Los valores calculados a partir de variables no se verifican. Los enlaces sin / inicial, como quickstart o ../quickstart, se resuelven desde el directorio de la página que los contiene, de la misma forma en que los resuelve un navegador. Para enlazar desde la raíz de tu sitio, comienza la ruta con /. Los enlaces relativos a la raíz que conservan la extensión .mdx, como /quickstart.mdx, se reportan como rotos porque Mintlify sirve las páginas sin la extensión. Elimina la extensión o añade una redirección desde la ruta .mdx a la página. Los enlaces relativos como ./quickstart.mdx en enlaces Markdown y valores href funcionan bien porque Mintlify elimina la extensión, pero las definiciones de enlaces de estilo referencia como [id]: ./quickstart.mdx la conservan y se reportan como rotas. Para los enlaces sin / inicial y los enlaces de anclaje (#) dentro de un snippet, el comando verifica cada página que renderiza el snippet. El comando solo reporta uno de estos enlaces si está roto en al menos una de esas páginas. Con --check-anchors, los encabezados dentro de un snippet cuentan como anclajes en las páginas que lo renderizan. 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.

mint a11y

Verifica problemas de accesibilidad en tu documentación.
Verifica las relaciones de contraste de color y la falta de texto alternativo en imágenes y videos.

mint validate

Revisa tu documentación en busca de errores y luego valida la compilación en modo estricto. Incluye validación automática de las especificaciones OpenAPI referenciadas en tu docs.json.
mint validate ejecuta un conjunto de reglas sobre tus páginas, snippets, navegación y especificaciones OpenAPI, y luego ejecuta una compilación estricta. Los hallazgos se muestran agrupados por archivo, con la línea, la columna y el nombre de la regla de cada uno cuando están disponibles. Las reglas duplicate-h1, katex, foreign-syntax y url-collision informan advertencias, por lo que sus hallazgos no hacen fallar la ejecución. Las demás reglas informan errores. La compilación estricta solo se ejecuta cuando ninguna regla informa un error y al menos una de las reglas seleccionadas necesita la compilación. Si una regla informa un error, el comando omite la compilación y te indica que primero corrijas los errores. Las advertencias que la compilación no puede atribuir a una regla hacen fallar la ejecución como errores build-failed. Con --fix, mint validate ejecuta hasta cinco pasadas de corrección, porque una corrección puede desbloquear otra. Por ejemplo, autocerrar un <br> puede permitir que una página se analice. Después de la última pasada, todas las reglas se ejecutan una vez más y el informe muestra lo que queda. La salida enumera cada corrección aplicada como fixed <file>:<line> <rule>: "before" → "after". --fix omite una corrección que se solapa con otra corrección en el mismo archivo. También deja sin cambios un archivo Markdown o MDX si el contenido corregido se analizaría peor que antes. Sin --fix, la salida termina con un recuento de los problemas que --fix corregiría.
Haz commit o stash de tus cambios antes de ejecutar --fix, para que puedas revisar sus modificaciones.
Con --format json, la salida de progreso se oculta y el resto de la salida de consola va a stderr, por lo que puedes analizar stdout directamente. El informe tiene estos campos:
  • passed: true cuando ninguna regla informó un error.
  • summary: recuentos de errors y warnings, además de byRule con un recuento por cada ID de regla.
  • diagnostics: cada hallazgo, con rule, group, severity (error o warning), file, line y column opcionales, message y un fix opcional.
  • build: { "ran": true, "passed": <boolean> } si se ejecutó la compilación estricta; en caso contrario, { "ran": false, "reason": <reason> } con un motivo de disabled, errors found o no build rules.
  • fixed: solo con --fix. Cada cambio aplicado, con rule, file, line y column opcionales, before y after.
Si mint validate no puede ejecutarse, no imprime nada en stdout y escribe Error: <message> en stderr. El comando finaliza con uno de estos códigos:
  • 0: Ninguna regla informó un error. Las advertencias no hacen fallar la ejecución.
  • 1: Al menos una regla informó un error.
  • 2: mint validate no pudo ejecutarse, por ejemplo por un nombre de regla desconocido, un valor de --files que no coincide con ninguna página ni snippet, o un fallo inesperado.
Usa mint validate en lugar del comando independiente mint openapi-check, que está obsoleto.

mint og

Genera la imagen de vista previa para redes sociales (OG) de una página como archivo PNG. El comando usa la configuración de thumbnails de tu docs.json, las sobrescrituras de thumbnail de páginas y secciones, y el mismo código de renderizado que tu sitio publicado.
El comando muestra advertencias cuando el título es demasiado largo para caber en dos líneas, cuando no hay un logotipo configurado o el logotipo no se puede cargar, cuando la fuente no se puede cargar y cuando el texto tiene poco contraste sobre una superficie brand. Las advertencias no cambian el código de salida. El comando finaliza con el código 1 si docs.json no es válido o la página no existe.

mint export

Exporta tu documentación como un archivo zip autónomo para visualización y distribución sin conexión.
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.
El comando muestra una puntuación general de preparación y un desglose de verificaciones individuales con indicadores de aprobado/reprobado.

Ejemplos

Verificaciones

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.

mint format

mint format reescribe los archivos in situ. Confirma o guarda tus cambios antes de ejecutarlo para que puedas revisar el diff.
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.
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.
Ejecutar mint format puede generar muchos cambios según el tamaño de tu proyecto. Para evitar conflictos de fusión y no introducir cambios en otro trabajo en curso, primero resuelve todas las ramas pendientes importantes. Luego crea una nueva rama para los cambios de formato y ejecuta mint format en esa rama.
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. Consulta Instalar en CI para ver un pipeline de ejemplo.

mint migrate

Muestra instrucciones paso a paso para migrar un sitio de documentación existente a Mintlify o pasa las instrucciones a un agente de IA para que complete la migración.
Sin flags, el comando muestra un resumen del flujo de migración seguido de los temas y las plataformas de origen disponibles. Las instrucciones están escritas para agentes de programación, así que puedes pegarlas en tu agente o dejar que tu agente ejecute mint migrate por sí mismo. Con --agent, la CLI inicia la herramienta de línea de comandos del agente especificado con un prompt para ejecutar mint migrate y seguir las instrucciones que muestra. Debes tener ya instalada la CLI del agente. Si la CLI de Mintlify no encuentra la CLI del agente, mint migrate termina con un error que incluye el comando de instalación.

Ejemplos


mint new

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

mint update

Actualiza la CLI y el cliente de vista previa local a las últimas versiones.

mint version

Muestra las versiones actuales de la CLI y del cliente.

mint feedback

Envía comentarios al equipo de Mintlify. No necesitas iniciar sesión. Nunca incluyas claves de API, tokens, contraseñas u otros secretos en el mensaje.

Ejemplos


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.

Telemetría

La CLI recopila telemetría 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, la arquitectura y la versión de Node.js. También registran si la CLI se ejecuta en un entorno de CI, si se ejecuta en una terminal interactiva, si es la primera vez que la CLI se ejecuta en tu equipo y si has iniciado sesión. Si la CLI detecta que la ejecuta un agente de programación con IA, la telemetría también incluye el nombre del agente. Cada evento también incluye un identificador de sesión que agrupa los eventos de la misma sesión de trabajo. La CLI lo almacena en ~/.config/mintlify/telemetry-session.json y lo reemplaza tras 30 minutos de inactividad. Si has iniciado sesión, los eventos de telemetría también incluyen el correo electrónico de tu cuenta. El uso sin sesión iniciada permanece anónimo, y cerrar sesión elimina tu correo electrónico almacenado. Mintlify no recopila 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:
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.