--- title: Referencia CLI description: Todos los comandos de create-thally-docs para crear, migrar y verificar proyectos Thally. url: https://docs.thally.io/es/guides/cli-reference --- # Referencia CLI Todos los comandos de create-thally-docs para crear, migrar y verificar proyectos Thally. La CLI `create-thally-docs` es la herramienta principal para trabajar con proyectos Thally desde la terminal. Instálala globalmente o ejecútala directamente con `npx`. ```bash npx create-thally-docs [command] [args] [options] ``` --- ## create-thally-docs (scaffold) Crea un nuevo proyecto de documentación Thally. ```bash npx create-thally-docs my-docs ``` La CLI guía a través de una configuración interactiva: - **Nombre del proyecto** — se muestra en el encabezado y los metadatos - **Descripción** — se usa para SEO y etiquetas OpenGraph - **Preset de marca** — `primary` (verde) o `secondary` (morado) - **URL del repositorio de GitHub** — configura automáticamente los enlaces de Soporte y GitHub - **Instalar dependencias** — ejecuta `npm install` por ti Omite todos los prompts y acepta los valores predeterminados con `--yes`: ```bash npx create-thally-docs my-docs --yes ``` ### Opciones | Bandera | Descripción | |---------|-------------| | `--skip-validation` | Solo importa; omite instalación de dependencias, comprobaciones y compilación | | `--yes`, `-y` | Acepta todos los valores predeterminados, omite los prompts interactivos | --- ## thally migrate Migra un sitio público de documentación o un repositorio de GitHub a un proyecto Thally. ```bash npx --yes @thallylabs/cli@latest migrate [output-dir] [options] ``` Para una URL pública, Thally descubre el sitemap, la navegación renderizada, las redirecciones y el contenido portátil. Para una URL de GitHub, clona el repositorio y lee Markdown, MDX, assets y la configuración de la plataforma de forma estática. **Plataformas fuente compatibles:** Mintlify, Docusaurus, Fern, GitBook, Nextra, VitePress, Starlight y cualquier repositorio con archivos Markdown simples. > **Usa el repositorio para la detección automática:** Un repositorio de GitHub es la fuente recomendada porque expone el contenido, la navegación, los assets, los archivos OpenAPI, las redirecciones y la configuración originales. ### Ejemplos ```bash # Recomendado: detectar la plataforma desde el repositorio fuente npx --yes @thallylabs/cli@latest migrate https://github.com/org/repo my-docs # Usar el sitio público cuando el repositorio no está disponible npx --yes @thallylabs/cli@latest migrate https://relay.dev/ relay-docs --max-pages 1000 # Ejecutar la misma migración Docusaurus sin prompts npx --yes @thallylabs/cli@latest migrate https://relay.dev/ relay-docs --platform docusaurus --max-pages 1000 --yes # Derivar el directorio de salida del nombre del repositorio npx --yes @thallylabs/cli@latest migrate https://github.com/mintlify/starter # Migrar una rama o subdirectorio específico npx --yes @thallylabs/cli@latest migrate https://github.com/org/repo/tree/main/docs my-docs # Migrar contenido a un proyecto Thally existente npx --yes @thallylabs/cli@latest migrate https://github.com/org/repo --into ./existing-docs ``` ### Qué se migra - Las páginas Markdown y MDX incluidas en el alcance de la fuente se convierten a MDX; Fern importa las páginas referenciadas por la navegación - Las páginas públicas se descubren mediante sitemaps y barras laterales renderizadas dentro de la ruta enviada - La navegación se detecta desde la configuración de Mintlify/Docusaurus/Fern (`mint.json`, `docusaurus.config.js`, `docs.yml`), la navegación renderizada, `docs.json` o la estructura de directorios - Se conservan los límites de la versión actual de Docusaurus, rutas sensibles a mayúsculas, redirecciones, plugins, avisos, pestañas, tablas y código resaltado - Las especificaciones OpenAPI locales y las referencias remotas que se pueden descargar y validar se guardan en `openapi/` y se conectan a la pestaña de API correspondiente - Los componentes MDX específicos de la plataforma se normalizan a sus equivalentes en Thally (ver [mapeo de componentes](#mapeo-de-componentes) a continuación) ### Opciones | Bandera | Descripción | |---------|-------------| | `--into ` | Migrar a un proyecto Thally existente en lugar de crear uno nuevo | | `--branch ` | Sobreescribir la rama de git detectada automáticamente | | `--docs-dir ` | Sobreescribir el subdirectorio de documentación detectado automáticamente | | `--platform ` | Seleccionar `mintlify`, `docusaurus`, `fern` o `auto` | | `--max-pages ` | Máximo de páginas públicas que se importarán (`1`–`1000`) | | `--api-key ` | Clave API de Anthropic para convertir archivos que no son Markdown (p. ej. `.rst`). Usa como alternativa la variable de entorno `ANTHROPIC_API_KEY` | | `--skip-validation` | Solo importa; omite instalación de dependencias, comprobaciones y compilación | | `--yes`, `-y` | Aceptar valores predeterminados y las limitaciones del sitio público, y omitir todos los prompts | > **Warning:** Si una migración interactiva con detección automática comienza desde una URL pública, la CLI ofrece cambiar al flujo recomendado desde GitHub. Continuar con la URL requiere confirmar que el resultado puede necesitar ajustes manuales y recomienda usar el servidor MCP de Thally para completar esos ajustes en un PR. `--platform auto` y `--yes` siguen siendo no interactivos y muestran la misma advertencia. La validación ejecuta MDX y componentes importados en tu equipo; usa fuentes propias o de confianza. Lee `migration-report.json` y resuelve los errores antes de publicar. ### Mapeo de componentes Mintlify, Docusaurus, Fern y GitBook usan componentes MDX específicos de la plataforma que no existen en Thally. La herramienta de migración los convierte automáticamente: | Fuente | Equivalente en Thally | |--------|-------------------| | `` | `` | | `` | `` | | `` | `` | | `` | `` / `` / `` | | `:::note ...:::` (Docusaurus) | `` | | Aviso de Docusaurus | `` / `` / `` / `` | | Pestañas de Docusaurus | `` y `` | | Tabla HTML renderizada | Tabla Markdown | | `{% hint style="..." %}` (GitBook) | `` / `` | | `` | eliminado (se mantienen los hijos) | | `` | `` | | `` / `` | Definición de propiedad en Markdown | | `` / `` | `` | | `` | `` | | Fern `` | `` | | Fern `` | `` | | Fern `` | `` | | Fern `` | `` | | Fern `` | `` | | Fern `` / `` | `` | | Fern `` / `` | `` | | Fern `` | `` | | Fern `` | `` | | Fern `` | eliminado (se mantienen los hijos) | > **Archivos que no son Markdown:** Los archivos en formato `.rst` u otros formatos requieren una clave API de Anthropic para convertirse. Establece `ANTHROPIC_API_KEY` en tu entorno o pasa `--api-key`. Los archivos `.md` y `.mdx` simples se migran de forma gratuita. --- ## thally check Verifica un proyecto Thally en busca de problemas comunes e informa errores y advertencias. ```bash npx --yes @thallylabs/cli@latest check [project-dir] ``` Usa el directorio actual si no se proporciona ninguna ruta. ### Qué verifica | Problema | Severidad | |----------|-----------| | Página listada en `docs.json` pero no se encontró archivo MDX | Error | | ID de página duplicado en `docs.json` | Error | | Pestaña sin grupos y sin `href` | Error | | Archivo MDX no listado en `docs.json` (huérfano) | Advertencia | | `title` faltante en el frontmatter | Advertencia | | `description` faltante en el frontmatter | Advertencia | | Cuerpo de página vacío o casi vacío | Advertencia | ```bash # Verificar el proyecto actual npx --yes @thallylabs/cli@latest check # Verificar un directorio específico npx --yes @thallylabs/cli@latest check /path/to/my-docs # Corregir automáticamente archivos huérfanos agregándolos a la navegación npx --yes @thallylabs/cli@latest check --fix ``` La CLI termina con el código `1` si se encuentran errores, `0` si el proyecto está limpio o solo tiene advertencias. ### Opciones | Bandera | Descripción | |---------|-------------| | `--fix` | Agregar automáticamente páginas huérfanas al último grupo de la primera pestaña de contenido | --- ## create-thally-docs translate Traduce páginas de documentación a una configuración regional secundaria usando Claude AI. Requiere un bloque `i18n` en `docs.json`. ```bash npx create-thally-docs translate --locale es ``` Los archivos traducidos se escriben en `src/content/{locale}/` y se confirman en tu repositorio — sin costo en tiempo de ejecución, SSG completo. ### Ejemplos ```bash # Traducir todas las páginas al español npx create-thally-docs translate --locale es # Traducir solo páginas específicas npx create-thally-docs translate --locale fr --pages introduction,guides/getting-started # Sobreescribir traducciones existentes npx create-thally-docs translate --locale es --force # Pasar la clave API explícitamente npx create-thally-docs translate --locale de --api-key sk-ant-... ``` ### Opciones | Bandera | Descripción | |---------|-------------| | `--locale ` | Código de configuración regional destino — requerido (debe estar en la configuración i18n de `docs.json`) | | `--pages ` | IDs de páginas separados por comas para traducir (omitir para todas las páginas) | | `--force` | Sobreescribir archivos de traducción existentes | | `--api-key ` | Clave API de Anthropic (usa como alternativa la variable de entorno `ANTHROPIC_API_KEY`) | | `--model ` | Modelo de Claude a usar (predeterminado: `claude-sonnet-4-6`) | | `--skip-validation` | Solo importa; omite instalación de dependencias, comprobaciones y compilación | | `--yes`, `-y` | Omitir el prompt de confirmación | Consulta [Soporte Multilingüe](/guides/multi-language) para obtener instrucciones completas de configuración.