Saltar al contenido principal

Flags globales

Estos flags están disponibles en todos los comandos.
FlagDescripción
--telemetry, -tHabilitar o deshabilitar la telemetría anónima de uso.
--help, -hMostrar la ayuda del comando.
--version, -vMostrar la versión de la CLI. Alias de mint version.

mint dev

Inicia una previsualización local de tu documentación.
mint dev [flags]
FlagDescripción
--portPuerto para ejecutar la previsualización local. Por defecto 3000.
--no-openNo abrir el navegador automáticamente.
--groupsLista separada por comas de grupos de usuarios a simular para la previsualización.
--disable-openapiOmitir el procesamiento de archivos OpenAPI para mejorar el rendimiento.
--local-schemaPermitir archivos OpenAPI alojados localmente servidos por HTTP.

mint login

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.

mint logout

Eliminar las credenciales almacenadas.
mint logout

mint status

Muestra la cuenta y la organización asociadas a tu sesión actual.
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:
FlagDescripción
--subdomainSubdominio de la documentación. Por defecto usa el valor establecido con mint config set subdomain.
--fromFecha de inicio en formato YYYY-MM-DD. Por defecto 7 días atrás, o el valor establecido con mint config set dateFrom.
--toFecha de fin en formato YYYY-MM-DD. Por defecto hoy, o el valor establecido con mint config set dateTo.
--formatFormato de salida: plain (por defecto), table, json o graph.
--agentSalida en JSON. Equivalente a --format json. También se activa automáticamente cuando la variable de entorno CLAUDECODE es 1.

mint analytics stats

Muestra un resumen de visitas, visitantes, búsquedas, comentarios y uso del asistente.
mint analytics stats [flags]
FlagDescripción
--pageFiltrar por una ruta de página específica.
--humansMostrar solo tráfico humano.
--agentsMostrar solo tráfico de agentes de IA.
Muestra consultas de búsqueda con recuento de resultados y tasas de clics.
mint analytics search [flags]
FlagDescripción
--queryFiltrar por subcadena de consulta de búsqueda.
--pageFiltrar por página más clicada.

mint analytics feedback

Muestra los comentarios enviados por los usuarios.
mint analytics feedback [flags]
FlagDescripción
--typeTipo de comentario: page (agregar por página) o code (comentarios de fragmentos de código).
--pageFiltrar 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]
FlagDescripción
--pageFiltrar 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 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]
SubcomandoDescripció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

ClaveDescripciónUsado por
subdomainSubdominio predeterminado de la documentación.mint analytics
dateFromFecha de inicio predeterminada para consultas de analítica (YYYY-MM-DD).mint analytics
dateToFecha de fin predeterminada para consultas de analítica (YYYY-MM-DD).mint analytics

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.
FlagDescripción
--check-anchorsTambién validar enlaces de ancla (por ejemplo, /page#section) contra los slugs de encabezados.
--check-externalTambién verificar URLs externas en busca de enlaces rotos.
--check-snippetsTambién verificar enlaces dentro de componentes <Snippet>.

mint a11y

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.
FlagDescripción
--skip-contrastOmitir las verificaciones de contraste de color.
--skip-alt-textOmitir 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]
FlagDescripción
--groupsLista separada por comas de grupos de usuarios a simular para la validación.
--disable-openapiOmitir el procesamiento y validación de archivos OpenAPI.
--local-schemaPermitir 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 workflow

Crea un archivo de flujo de trabajo de forma interactiva.
mint workflow
La CLI solicita un nombre, tipo de activador y otros ajustes, luego crea un archivo .md en .mintlify/workflows/.

mint export

Exporta tu documentación como un archivo zip autónomo para visualización y distribución sin conexión.
mint export [flags]
FlagDescripción
--outputNombre del archivo de salida. Por defecto export.zip.
--groupsLista separada por comas de grupos de usuarios para incluir páginas restringidas.
--disable-openapiOmitir el procesamiento de OpenAPI.
Consulta Exportación offline para más detalles.

mint new

Crea un nuevo proyecto de documentación a partir de la plantilla inicial de Mintlify.
mint new [directory] [flags]
FlagDescripción
--nameNombre del proyecto. La CLI lo solicita si no se proporciona en modo interactivo.
--themeTema del proyecto. La CLI lo solicita si no se proporciona en modo interactivo.
--forceSobrescribir 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.
ComandoDescripción
mint aiHerramientas de documentación con IA.
mint testPruebas de documentación.
mint signupRegistro de cuenta desde la CLI.
mint mcpServidor 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:
VariableValorDescripción
MINTLIFY_TELEMETRY_DISABLED1Deshabilitar la telemetría de la CLI de Mintlify.
DO_NOT_TRACK1Deshabilitar 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.