Jamdesk Documentation logo

CLI Deploy

Despliega documentación directamente desde la línea de comandos. Sube, construye y publica sin hacer push a GitHub.

El comando deploy empaqueta tu documentación, la sube a Jamdesk y activa un build desde la terminal. Úsalo para iteraciones rápidas, probar cambios o proyectos que no están conectados a un repositorio de GitHub.

Quick Start

jamdesk login        # First time only
jamdesk deploy       # From your project directory

Options

FlagDescripción
--detachEncola el build y sale inmediatamente (imprime un enlace al dashboard)
--full-rebuildFuerza un rebuild completo, ignorando la caché de build
--project <id>Despliega a un ID de proyecto específico (omite la selección interactiva)

jamdesk push es un alias de jamdesk deploy.

Cómo funciona

1
Autenticar

Verifica que tu sesión sea válida. Si tu token ha expirado, se te pedirá que ejecutes jamdesk login.

2
Cargar configuración

Lee y valida docs.json del directorio actual.

3
Resolver proyecto

Lee projectId de docs.json. Si no está presente (primer despliegue), la CLI te pedirá que selecciones entre tus proyectos. Tu elección se guarda en docs.json para que el siguiente despliegue omita el prompt.

Usa --project <id> para anular esto.

4
Empaquetar archivos

Crea un tarball comprimido de tu documentación, respetando .gitignore. Si algún archivo parece contener secretos, la CLI muestra una advertencia (pero no bloquea la subida).

5
Subir

Envía el tarball a Jamdesk mediante una URL prefirmada. El tamaño máximo de subida es 100 MB.

6
Build

Encola un build y sondea el estado, imprimiendo cada fase al completarse. Presiona Ctrl+C para dejar de sondear; el build continúa en segundo plano.

7
Listo

Imprime la URL en producción cuando el build finaliza.

Fases del Build

Durante el sondeo, verás cada fase completarse en secuencia:

FaseDescripción
Extracting filesDescomprimiendo el tarball subido
Validating configurationVerificando el esquema y contenido de docs.json
Preparing contentProcesando archivos MDX y assets
Building documentationCompilando páginas y generando artefactos estáticos
Uploading to CDNSubiendo el output construido a la red edge
Refreshing cachePurgando contenido obsoleto del CDN

Exclusiones de archivos

Los siguientes siempre se excluyen de las subidas, independientemente de tu .gitignore:

.git, node_modules, .next, .env, .env.*, *.pem, *.key, credentials.json, .gcloud, .DS_Store, Thumbs.db

Todo lo que esté en tu .gitignore también se excluye.

Advertencias de archivos secretos

La CLI advierte (pero no bloquea) cuando detecta archivos que parecen contener secretos:

  • Archivos .env y .env.*
  • Archivos *.pem y *.key
  • credentials.json
  • service_account*.json
  • Archivos que comienzan con secret

Agrégalos a .gitignore para suprimir la advertencia y excluirlos de las subidas.

Referencia de errores

ErrorCódigoCausaSolución
Not logged inAUTH_REQUIREDNo hay credenciales almacenadasjamdesk login
Session expiredAUTH_EXPIREDEl token no pudo renovarsejamdesk login
Access deniedFORBIDDENNo eres miembro de este proyectoVerifica la membresía del proyecto en el dashboard
Project not foundNOT_FOUNDID de proyecto inválidoVerifica el ID o elimina projectId de docs.json
Build in progressBUILD_IN_PROGRESSHay otro build en ejecuciónEspera o revisa el dashboard
Upload too largeTOO_LARGEEl servidor rechazó la subida (límite de 100 MB)Excluye archivos grandes mediante .gitignore
Project too largePROJECT_TOO_LARGEEl tarball supera 100 MB durante el empaquetadoExcluye archivos grandes mediante .gitignore
No projectsNO_PROJECTSNo hay proyectos en tu cuentaCrea un proyecto en el dashboard primero
No filesEMPTY_PROJECTTodos los archivos fueron excluidosRevisa tu .gitignore
Config invalidCONFIG_NOT_FOUNDFalta docs.json o es inválidoEjecuta desde la raíz del proyecto y revisa la configuración
Upload failedUPLOAD_FAILEDProblema de red durante la subidaVerifica tu conexión a internet y reintenta
Build failedBUILD_FAILEDError del servicio de buildRevisa los logs de build en el dashboard

Solución de problemas

Solo un build se ejecuta a la vez por proyecto. Espera a que el build actual finalice; revisa el estado en el dashboard bajo Deployments.

Asegúrate de ejecutar el comando desde el directorio que contiene docs.json. Ejecuta jamdesk validate para comprobar errores de configuración.

El límite de 100 MB se aplica al tarball comprimido de todos los archivos no excluidos. Revisa qué se está incluyendo. Las imágenes grandes, videos o archivos de datos son causas comunes; agrégalos a .gitignore para excluirlos.

Presiona Ctrl+C para salir; el build sigue ejecutándose en segundo plano. Revisa el dashboard para ver el estado. Si esto ocurre de forma consistente, tu red puede estar descartando las solicitudes de sondeo.

Necesitas al menos un proyecto en tu cuenta de Jamdesk. Crea uno en dashboard.jamdesk.com.

Para más soluciones de problemas de CLI, consulta la guía CLI del Centro de ayuda.

¿Qué sigue?

Flujo de despliegue

Auto-despliegue con GitHub y estado de despliegue

Autenticación

Flujo de inicio de sesión, sesiones y solución de problemas