Guía de Onboarding de CLI

Resumen rápido

El Capgo CLI proporciona una experiencia de onboarding interactiva que configura actualizaciones en vivo para tu aplicación Capacitor. Tendrás:

1. ✅ Registra tu aplicación en Capgo
2. 🔌 Instala y configura el plugin de actualizador
3. 🚀 Despliega tu primera actualización en vivo
4. 📱 Prueba la actualización en tu dispositivo

Tiempo estimado: 10-20 minutos (varía según tu velocidad de internet y tiempo de compilación)

Consejo

El proceso de inicio es completamente resumible - puedes salir en cualquier momento y continuar más adelante desde donde lo dejaste.

Iniciando el proceso de inicio

Ejecuta el comando de inicio con tu clave API:

npx @capgo/cli@latest init [APIKEY]

Verás el mensaje de bienvenida:

Capgo onboarding 🛫

¿Qué sucede durante la incorporación

El CLI le guiará a través de 13 pasos interactivos:

Fase de configuración (Pasos 1-6):

• Verifique su entorno de desarrollo (Xcode/Android Studio)
• Agregue su aplicación a Capgo y cree un canal de producción
• Instale el @capgo/capacitor-updater plugin
• Inyecte el code requerido en su aplicación
• Opcionalmente habilite la cifrado de extremo a extremo
• Elija una plataforma para la prueba (iOS o Android)

Fase de Prueba (Pasos 7-12):

• Construye tu aplicación y ejecútala en un dispositivo/simulador
• Haz un cambio visible (code) (automático o manual)
• Sube el paquete actualizado a (Capgo)
• Ve cómo aparece la actualización en vivo en tu dispositivo en tiempo real

Compleción (Paso 13):

• Tu aplicación está lista para actualizaciones en vivo! 🎉

El Proceso de Incorporación de 13 Pasos

Paso 1: Verifica los Requisitos Previos

La CLI verifica tu entorno de desarrollo para asegurarse de que tengas las herramientas necesarias instaladas.

¿Qué se ha verificado:

• Xcode (solo para macOS) - para el desarrollo de iOS
• Android SDK - para el desarrollo de Android

Posibles resultados:

✅ Se encontraron ambos entornos:

✅ Xcode detected - iOS development ready
✅ Android SDK detected - Android development ready

⚠️ No se encontró ningún entorno:

⚠️ Xcode not found
⚠️ Android SDK not found
❌ No development environment detected

📱 To develop mobile apps with Capacitor, you need:
   • For iOS: Xcode (macOS only) - https://developer.apple.com/xcode/
   • For Android: Android Studio - https://developer.android.com/studio

Preguntas a las que podrías ser objeto:

Cuidado

Si no se detecta un entorno de desarrollo, se le preguntará si desea continuar. Se recomienda instalar al menos una plataforma antes de proceder.

Paso 2: Agregar su aplicación

El CLI le permitirá iniciar sesión en Capgo y agregar su aplicación a su cuenta.

(spinner) Running: npm @capgo/cli@latest login ***
Login Done ✅

❓ Add {appId} in Capgo?

Si su ID de aplicación ya está tomado:

El CLI le sugerirá alternativas:

❌ App ID "com.example.app" is already taken
💡 Here are some suggestions:
   1. com.example.app2
   2. com.example.app3
   3. com.example.app.new
   4. com.example.app.app

❓ What would you like to do?

Puede elegir una sugerencia o ingresar un ID de aplicación personalizado.

Nota

Los IDs de la aplicación deben seguir la notación de dominio inverso (por ejemplo, com.example.myapp)

Paso 3: Crear Canal de Producción

Los canales te permiten gestionar diferentes flujos de actualizaciones para tu aplicación.

❓ Create default channel production for {appId} in Capgo?

Consejo

No te preocupes! Esto es solo para pruebas locales durante la incorporación. Crear un ‘canal de producción’ no significa que tus actualizaciones se publiquen inmediatamente a los clientes. Tienes control total sobre cuándo se despliegan las actualizaciones. Selecciona Sí a menos que tengas requisitos de canal específicos.

Si seleccionas Sí:

(spinner) Running: npm @capgo/cli@latest channel add production {appId} --default
Channel add Done ✅  (or "Channel already added ✅")

Se creará un canal de producción y se establecerá como predeterminado. Esta es la opción recomendada para la mayoría de los usuarios.

Si seleccionas No:

If you change your mind, run it for yourself with: "npm @capgo/cli@latest channel add production {appId} --default"

Necesitarás crear y configurar canales manualmente más tarde. Alternativamente, puedes:

• Establecer el canal en tu capacitor.config.ts archivo
• Usar el método JavaScript para establecer dinámicamente el canal setChannel() Configurar canales más tarde desde la consola web __CAPGO_KEEP_0__
• Configure channels later from the Capgo web console

Título de la sección “Paso 4: Instalar Plugin de Actualizador”

El CLI instalará el @capgo/capacitor-updater plugin compatible con tu versión de Capacitor.

❓ Automatic Install "@capgo/capacitor-updater" dependency in {appId}?

Compatibilidad de versión:

• Capacitor 5: Instala @capgo/capacitor-updater v5
• Capacitor 6: Instala @capgo/capacitor-updater v6
• Capacitor 7: Instala @capgo/capacitor-updater v7
• Capacitor 8+Instala la versión más reciente:

Cuidado

Capgo solo admite Capacitor v5 y superior. Si estás utilizando una versión anterior, necesitarás actualizar primero.

Opción de actualizaciones instantáneas:

Después de la instalación, te preguntarán:

❓ Do you want to set instant updates in {appId}?
   Read more: https://capgo.app/docs/live-updates/update-behavior/#applying-updates-immediately

Consejo

¿Qué son las actualizaciones instantáneas? With instant updates enabled, your app applies updates immediately when backgrounded and reopened. This works seamlessly because Capgo can distribute updates worldwide in under 300ms. Without it (standard mode), updates download in the background and apply on the next app restart. Instant updates are great for faster iteration during development and critical bug fixes in production.

Si selecciona Sí:

• Las actualizaciones se configurarán para aplicarse de inmediato cuando la aplicación esté en segundo plano y se vuelva a abrir
• autoUpdate: 'always' y autoSplashscreen: true se agregarán a tu configuración
• Tu capacitor.config.ts se actualizará automáticamente
• Actualizaciones delta se habilitarán automáticamente - esto envía solo los archivos que cambiaron entre actualizaciones en lugar de el conjunto completo, lo que hace que las actualizaciones sean mucho más rápidas

Si selecciona No:

• Las actualizaciones utilizarán el comportamiento estándar (descargar en segundo plano, aplicar en el próximo reinicio)
• Puedes habilitar actualizaciones instantáneas más tarde modificando tu configuración capacitor.config.ts

Step 5: Agrega Integración Code

El CLI inyectará automáticamente los code necesarios en tu archivo de aplicación principal.

❓ Automatic Add "CapacitorUpdater.notifyAppReady()" code and import in {appId}?

¿Qué se agrega:

import { CapacitorUpdater } from '@capgo/capacitor-updater'

CapacitorUpdater.notifyAppReady()

Detección de tipo de proyecto:

• Nuxt.js: Crea plugins/capacitorUpdater.client.ts
• Otros frameworks: Agrega a tu archivo de entrada principal

Consejo

Si falla la inyección automática, puedes agregar el code manualmente a tu archivo de aplicación principal:

Para Nuxt.js: Crear plugins/capacitorUpdater.client.ts:

import { CapacitorUpdater } from '@capgo/capacitor-updater'

export default defineNuxtPlugin(() => {
  CapacitorUpdater.notifyAppReady()
})

Para otros frameworks: Agregar a tu archivo de entrada principal (por ejemplo, main.ts, index.js, App.tsx):

import { CapacitorUpdater } from '@capgo/capacitor-updater'

CapacitorUpdater.notifyAppReady()

Coloca este code después de tus importaciones y antes de la inicialización de tu aplicación. Para obtener más detalles, consulta la Agregar una aplicación guía.

Paso 6: Configuración de cifrado (opcional)

El cifrado de extremo a extremo agrega una capa de seguridad adicional para tus actualizaciones.

🔐 End-to-end encryption
   ✅ Use this for: Banking, healthcare, or apps with legal encryption requirements
   ⚠️  Note: Makes debugging harder - skip if you don't need it

❓ Enable end-to-end encryption for {appId} updates?

Nota

El cifrado solo está disponible para Capacitor v6 y versiones posteriores.

Si habilitas el cifrado, el CLI realizará lo siguiente:

1. Generar claves de cifrado
2. Ofrecer sincronizar la configuración de Capacitor

Paso 7: Seleccionar plataforma

Elige qué plataforma probar durante el proceso de incorporación.

📱 Platform selection for onboarding
   This is just for testing during onboarding - your app will work on all platforms

❓ Which platform do you want to test with during this onboarding?
   Options:
   - iOS
   - Android

Consejo

Solo afecta el proceso de inicio. Tu aplicación final apoyará todas las plataformas.

Paso 8: Construye tu proyecto

El CLI construirá tu aplicación y sincronizará con Capacitor.

❓ Automatic build {appId} with "npm run build"?

¿Qué sucede:

1. Detecta el tipo de proyecto
2. Ejecuta tu script de compilación
3. Ejecuta npx cap sync {platform}

Si el script de compilación está faltando:

Se le preguntará si desea saltar la compilación o agregar un script de compilación a su package.json.

Paso 9: Ejecutar en Dispositivo

Pruebe la versión inicial de su aplicación en un dispositivo o simulador.

❓ Run {appId} on {PLATFORM} device now to test the initial version?

Si selecciona Sí:

(spinner) Running: npx cap run {platform}
(device picker appears)
App started ✅
📱 Your app should now be running on your {platform} device with Capgo integrated
🔄 This is your baseline version - we'll create an update next

Paso 10: Hacer un Cambio de Prueba

Ahora es el momento de probar el sistema de actualizaciones de Capgo haciendo un cambio visible.

🎯 Now let's test Capgo by making a visible change and deploying an update!

❓ How would you like to test the update?
   Options:
   - Auto: Let Capgo CLI make a visible change for you
   - Manual: I'll make changes myself

Modo automático: El CLI modificará automáticamente tus archivos para agregar una bandera de prueba visible o cambiar.

Modo manual: Tú haces tus propios cambios (por ejemplo, cambiar texto, colores o agregar elementos).

Gestión de versiones:

❓ How do you want to handle the version for this update?
   Options:
   - Auto: Bump patch version ({currentVersion} → {nextVersion})
   - Manual: I'll provide the version number

Construir con cambios:

❓ Build {appId} with changes before uploading?

Consejo

Si necesitas construir manualmente en otra terminal, selecciona “No” y construye tú mismo, luego continúa.

Paso 11: Subir Paquete

Sube tu paquete de la aplicación actualizado a Capgo.

❓ Upload the updated {appId} bundle (v{version}) to Capgo?

El CLI ejecuta:

npx @capgo/cli@latest bundle upload

Consejo

Actualizaciones delta con actualizaciones instantáneas: Si habilitaste actualizaciones instantáneas en el paso 4, el CLI preguntará automáticamente si deseas habilitar actualizaciones delta. Las actualizaciones delta envían solo los archivos que cambiaron entre versiones en lugar del paquete completo. Dado que normalmente solo cambian unos pocos archivos entre actualizaciones, esto hace que las descargas sean mucho más rápidas. Selecciona Sí para la mejor experiencia con actualizaciones instantáneas.

Actualizaciones Delta (si se habilita el modo de aplicación instantánea):

💡 Instant updates are enabled in your config
   Delta updates send only changed files instead of the full bundle

❓ Enable delta updates for this upload? (Recommended with instant updates)

Advertencia

Para repositorios monolíticos, es posible que debas proporcionar rutas adicionales a tu package.json y node_modules.

Éxito:

✅ Update v{version} uploaded successfully!
🎉 Your updated bundle is now available on Capgo

Paso 12: Probar actualización en dispositivo

¡Ya es hora de ver la actualización en acción!

🧪 Time to test the Capgo update system!
📱 Go to your device where the app is running

Para actualizaciones instantáneas:

🔄 IMPORTANT: Background your app (swipe up/press home button) and then reopen it
⏱️  The update should be downloaded and applied automatically

Para actualizaciones estándar:

📱 With standard updates, you will need to:
   1. Background the app (swipe up/press home button) to start download
   2. Wait a few seconds for download to complete
   3. Background and foreground again to see the update

Monitorear registros:

❓ Monitor Capgo logs to verify the update worked?

Si seleccionas Sí, verás registros en vivo de tu dispositivo que muestran el proceso de actualización.

Paso 13: Finalización

Welcome onboard ✈️!

¡Felicidades! Has configurado Capgo actualizaciones en vivo para tu aplicación con éxito.

Lo que has logrado

Después de completar la onboarding, tienes:

✅ Aplicación Registrada

Tu aplicación está registrada en Capgo con un canal de producción

✅ Plugin Instalado

El plugin de actualizaciones de Capacitor está instalado y configurado

✅ Code Integrado

La integración de code se ha agregado a tu aplicación

✅ Actualización Probada

Has desplegado con éxito y recibido una actualización en vivo

Flujo diario

Para actualizaciones posteriores, utilice:

npm run build
npx @capgo/cli@latest bundle upload --channel=production

Para más opciones de despliegue, consulte Desplegar una actualización en vivo.

Reanudando la Onboarding

Si sale del proceso de onboarding, puede reanudar en cualquier momento:

npx @capgo/cli@latest init [APIKEY]

Verás:

You have already got to the step {stepNumber}/13 in the previous session
❓ Would you like to continue from where you left off?

Consejo

El progreso se guarda localmente, por lo que puedes salir y reanudar el proceso de incorporación de forma segura.

Solución de problemas

No hay entorno de desarrollo

Problema: Ni Xcode ni Android SDK se detecta.

Solución:

• Para iOS: Instale Xcode (solo para macOS)
• Para Android: Instale Android Studio

ID de Aplicación ya Tomado

Problema: Su ID de aplicación ya está registrada.

Solución: Elige una de las alternativas sugeridas o introduce un ID de aplicación personalizado en notación de dominio inverso.

Falta de Script de Construcción

Problema: No se encontró un script de construcción en package.json.

Solución: Agrega un script de construcción a tu package.json:

{
  "scripts": {
    "build": "your-build-command"
  }
}

Falló la Inyección Automática

Problema: CLI no puede inyectar automáticamente la integración code.

Solución: Agregue manualmente code a su archivo principal:

import { CapacitorUpdater } from '@capgo/capacitor-updater'

CapacitorUpdater.notifyAppReady()

Capacitor Versión Demasiado Antigua

Problema: Su versión de Capacitor es inferior a v5.

Solución: Actualice Capacitor a v5 o superior:

• Actualizando a Capacitor 5
• Actualizando a Capacitor 6
• Actualizando a Capacitor 7

Pasos siguientes

Ahora que has completado el proceso de incorporación, explora estos temas:

Lista de verificación de configuración única

Configura canales, CI y subida de delta una vez para estabilidad a largo plazo

Despliegue de actualizaciones

Aprende a desplegar actualizaciones desde la consola de Capgo

Tipos de actualizaciones

Referencia de todos los tipos de actualizaciones OTA: aplicación de plazos, condiciones de retraso, bloqueo de versión y entrega

Integración CI/CD

Automatiza tus despliegues de actualizaciones con CI/CD

Canales

Administra múltiples flujos de actualizaciones con canales

Cifrado

Protege tus actualizaciones con cifrado de extremo a extremo

Comportamiento de Actualización

Personaliza cuándo y cómo se aplican las actualizaciones (directo, delta, etc.)

Obtener Ayuda

Si encuentras problemas durante el proceso de incorporación:

• Verifica el Guía de Solución de Problemas
• Únete a Comunidad de Discord
• Revisa el Preguntas Frecuentes
• Contacto Soporte

Sigue adelante desde la Guía de Inicio de Sesión CLI

Si estás utilizando CLI Guía de Inicio de Sesión para planificar la consola y las operaciones de API , conecta con API Resumen para obtener detalles de implementación en API Resumen, Introducción para los detalles de implementación en Introducción, API Claves para los detalles de implementación en API Claves, Dispositivos para los detalles de implementación en Dispositivos, y Paquetes para los detalles de implementación en Paquetes.