Visión general de la CLI

Crea un nuevo proyecto de documentación.

jamdesk init              # Interactive mode
jamdesk init my-docs      # Create in new directory

Esto crea un nuevo proyecto con:

• Archivo de configuración docs.json
• Páginas MDX de ejemplo
• Estructura de carpetas recomendada

Inicia sesión en Jamdesk mediante tu navegador. Necesario antes de desplegar.

jamdesk login

Abre el dashboard de Jamdesk en tu navegador para la autenticación. Las credenciales se almacenan localmente en ~/.jamdeskrc.

Borra las credenciales almacenadas.

jamdesk logout

Muestra el usuario autenticado actual y verifica que tu sesión sea válida.

jamdesk whoami

Valida la configuración de tu docs.json, la sintaxis de MDX y las especificaciones de OpenAPI.

jamdesk validate
jamdesk validate --skip-mdx

Comprueba lo siguiente:

• Sintaxis JSON válida en docs.json
• Campos obligatorios (name, navigation)
• Valores de tema válidos
• Errores de sintaxis de MDX (por ejemplo, caracteres < sin escapar)
• Validación de especificaciones de OpenAPI (si está configurado)
• Cumplimiento del esquema

Opciones:

Ejecuta este comando antes de desplegar para detectar errores a tiempo.

Analiza tu documentación en busca de enlaces internos rotos.

jamdesk broken-links

Ejemplo de salida:

docs/getting-started.mdx:15 - /docs/quikstart
  Did you mean: /docs/quickstart

Found 1 broken link in 45 files.

Detecta enlaces a páginas faltantes y errores tipográficos. Consulta Enlaces y navegación para más detalles.

Corrige automáticamente las advertencias de enlaces internos rotos que tienen un destino inequívoco. Gestiona dos categorías:

• Anclas con errores tipográficos: un fragmento como #instalation que claramente debería ser #installation
• Desviación de anclas entre configuraciones regionales: una página traducida cambió el nombre de sus encabezados, pero los enlaces de esa configuración regional siguen apuntando al fragmento en inglés antiguo

# Preview what would change without touching any files
jamdesk fix --dry-run

# Apply fixes (prompts for confirmation)
jamdesk fix

Ejemplo de salida en modo dry-run:

Planned fixes:

  fr/ai/overview.mdx:9
    /fr/ai/selectors#ai-strategies  →  /fr/ai/selectors#stratégies-ia

(dry run — no files written)

Una corrección solo se escribe cuando el ancla corregida corresponde a un encabezado real en la página de destino. Los casos ambiguos se dejan para revisión manual.

Opciones:

Revisa tu documentación en busca de errores ortográficos.

jamdesk spellcheck

Ejemplo de salida:

getting-started.mdx:14 - "recieve"
  └─ Did you mean: receive

Found 3 misspellings across 24 pages.
Tip: Run "jamdesk spellcheck --fix" to interactively fix or ignore words.

Utiliza un diccionario en inglés con más de 150 términos técnicos integrados (API, GraphQL, Kubernetes, React, etc.) para que la jerga habitual no se marque. Omite los bloques de código, el código en línea, el frontmatter, el JSX, las URL y las rutas de archivo. Actualmente solo en inglés; está prevista la compatibilidad con diccionarios multilingües.

Opciones:

El modo de corrección interactivo (--fix) recorre cada palabra mal escrita única:

1/10  "recieve" — found in 3 files
      intro.mdx:14, setup.mdx:7, guide.mdx:22

? What do you want to do?
❯ Fix → receive (recommended)
  Fix → relieve
  Ignore in the future (add to docs.json)
  Skip

• Fix reemplaza la palabra por una sugerencia en todos los archivos (seguro para la prosa, no modifica los bloques de código ni los atributos JSX). Se muestran hasta 3 sugerencias, con la mejor coincidencia marcada como recomendada.
• Ignore añade la palabra a spellcheck.ignore en tu docs.json para que no se vuelva a marcar
• Skip no hace nada en esta ejecución

Los cambios se previsualizan y confirman antes de aplicarse.

Lista de exclusión personalizada: añade términos específicos del proyecto a tu docs.json:

{
  "spellcheck": {
    "ignore": ["YourProduct", "kubectl", "Terraform"]
  }
}

El nombre de tu proyecto de docs.json se excluye automáticamente.

Valida un único archivo de especificación de OpenAPI.

jamdesk openapi-check openapi.yaml
jamdesk openapi-check api/spec.json

Valida lo siguiente:

• Sintaxis YAML/JSON válida
• Cumplimiento del esquema OpenAPI 3.x
• Definiciones de endpoints
• Las referencias $ref se resuelven correctamente

Cambia el nombre de una página y actualiza automáticamente todas las referencias.

jamdesk rename docs/old-name.mdx docs/new-name.mdx

Esto hará lo siguiente:

• Cambiar el nombre del archivo
• Actualizar la navegación en docs.json
• Actualizar los enlaces en todos los demás archivos MDX
• Actualizar las referencias de snippet

Usa este comando en lugar de renombrar manualmente para mantener todas las referencias sincronizadas.

Migra la documentación de Mintlify a Jamdesk.

jamdesk migrate

Detecta tu configuración de Mintlify y la convierte al formato de Jamdesk. En el mismo paso, cambia el nombre de los componentes obsoletos (por ejemplo, CardGroup → Columns), traslada los archivos MDX de snippets huérfanos a /snippets/ y reescribe las importaciones relativas al padre, extrae los componentes en línea que usan hooks de React a /snippets/<name>.tsx con 'use client', y corrige automáticamente los problemas mecánicos de sintaxis MDX. Es idempotente, por lo que puedes volver a ejecutarla de forma segura.

Sube tu documentación y activa un build directamente desde la terminal.

jamdesk deploy
jamdesk deploy --detach
jamdesk deploy --full-rebuild

El progreso se muestra en directo a medida que se completa cada fase del build. También está disponible como jamdesk push.

Genera y despliega un Cloudflare Worker que redirige /docs en tu propio dominio hacia tu sitio de Jamdesk.

jamdesk deploy-proxy cloudflare
jamdesk deploy-proxy cloudflare --slug myproject --domain example.com --yes

Interactivo de forma predeterminada: comprueba Wrangler, verifica tu cuenta de Cloudflare, detecta automáticamente tu slug a partir de docs.json, genera los archivos del Worker y despliega opcionalmente. Con --yes, genera los archivos y se detiene; despliega con npx wrangler deploy desde el directorio de salida.

Verifica tu entorno y diagnostica problemas.

jamdesk doctor

Comprobaciones:

• Versión de Node.js (requiere v20+)
• Versión de npm
• docs.json existe y es válido
• Estado de la caché de ~/.jamdesk
• Permisos de escritura

Ejecuta este comando si tienes problemas con el CLI.

Borra el directorio de caché ~/.jamdesk.

jamdesk clean

Esto elimina las dependencias en caché y los artefactos del build. Úsalo para:

• Liberar espacio en disco
• Solucionar problemas de caché dañada
• Forzar una instalación limpia de dependencias

Las dependencias se reinstalarán en el próximo jamdesk dev.

Actualiza el CLI a la última versión.

jamdesk update

También puedes actualizar manualmente:

npm update -g jamdesk