Saltar al contenido principal

Flags globales

Estos flags están disponibles en todos los comandos.

mint dev

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

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

Crea, lista y elimina automatizaciones desde la terminal. Requiere autenticación con mint login.
mint workflow y mint workflows siguen funcionando como alias de mint automations, por lo que los scripts existentes seguirán ejecutándose. Los scripts nuevos deben usar mint automations.
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.

mint automations create

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

Ejemplos

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

mint automations list

Lista las automatizaciones del despliegue actual.
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.

mint automations delete

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

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 excluye los archivos que coinciden con los patrones de .mintignore. Los enlaces que apuntan a archivos ignorados se reportan como rotos.

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

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.
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.
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 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 a la última versión.

mint version

Muestra las versiones actuales de la CLI y del cliente.

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