Guía de Inicio de Sesión de CLI

Sección titulada “Vista rápida”

The Capgo CLI provides an interactive onboarding that sets up live updates for your Capacitor app. You’ll:

1. ✅ Register your app in Capgo
2. 🔌 Instale y configure el plugin de actualización
3. 🚀 Despliegue su primera actualización en vivo
4. 📱 Pruebe la actualización en su dispositivo

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

Consejo

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

Iniciando el proceso de inicio

Ejecute la orden de inicio con su clave API:

npx @capgo/cli@latest init [APIKEY]

Verá el mensaje de bienvenida:

Capgo onboarding 🛫

¿Qué sucede durante la configuració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 los code necesarios en su aplicación
• Opcionalmente habilitar la cifrado de extremo a extremo
• Elegir una plataforma para la prueba (iOS o Android)

Fase de prueba (Pasos 7-12):

• Construya su aplicación y ejecútela en un dispositivo/simulador
• Haga un cambio visible code (automático o manual)
• Suba el paquete actualizado a Capgo
• Vea la actualización en vivo aparecer en su dispositivo en tiempo real

Compleción (Paso 13):

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

El proceso de incorporación de 13 pasos

Paso 1: Verificar los requisitos previos

El CLI verifica su entorno de desarrollo para asegurarse de que tenga las herramientas necesarias instaladas.

¿Qué se verifica:

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

Posibles resultados:

✅ Ambos entornos encontrados:

✅ 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 que podrías ser preguntado:

Precaución

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

Paso 2: Agregar tu aplicación

El CLI te registrará en Capgo y agregará tu aplicación a tu cuenta.

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

❓ Add {appId} in Capgo?

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

El CLI 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?

Puedes 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 el proceso de incorporación. Crear un ‘canal de producción’ no significa que tus actualizaciones se publicarán inmediatamente a los clientes. Tienes control total sobre cuándo se despliegan las actualizaciones. Selecciona Sí a menos que tenga requisitos específicos de canal.

Si selecciona 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 selecciona No:

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

Tendrá que crear y configurar los canales manualmente más tarde. Alternativamente, puede:

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

Step 4: Instale el Plugin de Actualización

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 5Instala la versión 5 @capgo/capacitor-updater __CAPGO_KEEP_0__ 6
• Capacitor 6Copy to clipboard @capgo/capacitor-updater : Instala la versión
• Capacitor 7: Instala @capgo/capacitor-updater v7
• Capacitor 8+: Instala la última versión

Advertencia

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

Opción de actualizaciones instantáneas:

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

❓ 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? Con las actualizaciones instantáneas habilitadas, su aplicación aplica actualizaciones de inmediato cuando se pone en segundo plano y se vuelve a abrir. Esto funciona sin problemas porque Capgo puede distribuir actualizaciones en todo el mundo en menos de 300ms. Sin él (modo estándar), las actualizaciones se descargan en segundo plano y se aplican en la próxima reiniciación de la aplicación. Las actualizaciones instantáneas son ideales para una iteración más rápida durante el desarrollo y correcciones críticas de errores en producción.

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 su configuración
• Su 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 la versión completa del paquete, 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 la próxima reiniciación)
• Puede habilitar siempre las actualizaciones instantáneas más tarde modificando su capacitor.config.ts

Paso 5: Agregar Integración Code

El CLI inyectará automáticamente los code requeridos en su 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()

Deteció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 manualmente el code 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: Agrega 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 Guía para agregar una aplicación.

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

Esto solo afecta el proceso de incorporación. 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 falta el script de compilación:

Se te pedirá si deseas saltarte la compilación o agregar un script de compilación a tu package.json.

Paso 9: Ejecutar en Dispositivo

Prueba la versión inicial de tu aplicación en un dispositivo o simulador.

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

Si seleccionas 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

Es hora 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 sus archivos para agregar una bandera de prueba visible o cambiar.

Modo manual: Usted hace sus 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 necesita compilar manualmente en otra terminal, seleccione “No” y compile usted mismo, luego continúe.

Paso 11: Subir paquete

Suba su paquete de aplicación actualizado a Capgo.

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

La CLI ejecuta:

npx @capgo/cli@latest bundle upload

Consejo

Actualizaciones delta con actualizaciones instantáneas: If you enabled instant updates in Step 4, the CLI will automatically ask if you want to enable delta updates. Delta updates envían solo los archivos que cambiaron entre versiones en lugar de todo el paquete. Dado que normalmente solo unos pocos archivos cambian entre actualizaciones, esto hace que las descargas sean mucho más rápidas. Seleccione Sí para obtener la mejor experiencia con actualizaciones instantáneas.

Prompt de actualizaciones delta (si se habilita un 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, puede necesitar proporcionar rutas adicionales a tus package.json y node_modules.

Éxito:

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

Paso 12: Prueba de actualización en dispositivo

¡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.

Step 13: Finalización

Welcome onboard ✈️!

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

Lo que has logrado

Después de completar la configuración de inicio, 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 code se agrega a tu aplicación

✅ Actualizado Probado

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

Flujo de trabajo diario

Para actualizaciones posteriores, utilice:

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

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

Reanudando la asistencia

If you exit the onboarding process, you can resume anytime:

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 onboarding de manera segura.

Solución de problemas

No hay entorno de desarrollo

Problema: Ni Xcode ni Android SDK se detectó.

Solución:

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

Ya se ha tomado el ID de la aplicación

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

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

Falta de Script de Construcción

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

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

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

Fallo de Inyección Automática

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

Solución: Agregar code manualmente a tu archivo principal:

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

CapacitorUpdater.notifyAppReady()

Capacitor Versión Demasiado Antigua

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

Solución: Actualizar Capacitor a v5 o superior:

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

Pasos siguientes

Ahora que has completado la configuración de inicio, 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

Despliega 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

Gestiona múltiples flujos de actualizaciones con canales

Encriptación

Protege tus actualizaciones con encriptación de extremo a extremo

Comportamiento de Actualización

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

Obtener Ayuda

Revisa el

• Revisa el Guía de solución de problemas
• Únete a la Comunidad de Discord
• Revisa el FAQ
• Contacto Soporte

Sigue adelante desde la Guía de Onboarding de CLI

Si estás utilizando la Guía de Onboarding de CLI para planificar la consola de dashboard y API operaciones, conecta con API Resumen para el detalle de implementación en API Resumen Introducción para el detalle de implementación en Introducción API Claves para el detalle de implementación en API Claves Dispositivos para el detalle de implementación en Dispositivos, y Paquetes para el detalle de implementación en Paquetes.