CLI Guía de Inicio

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 se puede reanudar completamente - puedes salir en cualquier momento y continuar más adelante desde donde te detuviste.

Iniciar el Proceso de Inicio

Ejecuta el comando de inicio con tu API clave:

npx @capgo/cli@latest init [APIKEY]

Verás el mensaje de bienvenida:

Capgo onboarding 🛫

¿Qué Sucede Durante el Proceso de Inicio?

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
• Elige una plataforma para la prueba (iOS o Android)

Fase de prueba (Pasos 7-12):

• Construya su aplicación y la ejecute en un dispositivo/simulador
• Haga un cambio code visible (automático o manual)
• Suba el paquete actualizado a Capgo
• Ve cómo la actualización en vivo aparece en tu dispositivo en tiempo real

Compleción (Paso 13):

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

El Proceso de Inicio de 13 Pasos

Paso 1: Verificar Requisitos Previos

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

Lo que se verifica:

• Xcode (solo macOS) - para el desarrollo de iOS
• Android SDK - para 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:

Advertencia

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

Paso 2: Agrega tu 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 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 'canales 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 tengas requisitos específicos de canales.

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"

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

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

Sección titulada “Paso 4: Instalar Plugin de Actualizador”

plugin compatible con tu versión de CLI @capgo/capacitor-updater plugin compatible with your Capacitor version.

❓ 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á utilizando una versión más antigua, 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 está en segundo plano y se vuelve a abrir. Esto funciona de manera fluida porque Capgo puede distribuir actualizaciones en todo el mundo en menos de 300ms. Sin ella (modo estándar), las actualizaciones se descargan en segundo plano y se aplican al reiniciar la aplicación. Las actualizaciones instantáneas son ideales para una iteración más rápida durante el desarrollo y correcciones de errores críticos 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 se agregará a tu configuración autoSplashscreen: true será actualizado automáticamente
• Delta actualizaciones capacitor.config.ts serán habilitadas automáticamente - esto envía solo los archivos que cambiaron entre actualizaciones en lugar de el paquete completo, lo que hace que las actualizaciones sean mucho más rápidas
• Si seleccionas No: Las actualizaciones utilizarán el comportamiento estándar (descargar en segundo plano, aplicar en el próximo reinicio)

Puedes habilitar siempre las actualizaciones instantáneas más tarde modificando tu

• Paso 5: Agregar Integración __CAPGO_KEEP_0__
• Sección titulada “Paso 5: Agregar Integración __CAPGO_KEEP_0__” capacitor.config.ts

El Code inyectará automáticamente los __CAPGO_KEEP_1__ requeridos en tu archivo de aplicación principal.

The CLI will automatically inject the required code into your main application file.

❓ 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 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: Agrega a tu archivo principal de entrada (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 más detalles, consulta la Guía de 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

La cifrado solo está disponible para Capacitor v6 y superior.

Si habilita la cifrado, el CLI realizará:

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

Paso 7: Seleccionar plataforma

Elegir qué plataforma probar durante la 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. Su aplicación final apoyará todos los sistemas operativos.

Paso 8: Construye tu proyecto.

El CLI construirá tu aplicación y la 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: Ejecuta 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

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: Usted hace sus propias modificaciones (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 construir manualmente en otra terminal, seleccione “No” y construya usted mismo, luego continúe.

Paso 11: Subir paquete

Suba su paquete de la aplicación actualizada 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: Si habilitaste actualizaciones instantáneas en el paso 4, la CLI solicitará automáticamente si deseas habilitar actualizaciones delta. Las actualizaciones delta envían solo los archivos que cambiaron entre versiones en lugar de el conjunto 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.

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)

Cuidado

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

For 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 con éxito Capgo actualizaciones en vivo para tu aplicación.

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 actualización 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 y recibido una actualización en vivo con éxito

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 reanudarlo en cualquier momento:

npx @capgo/cli@latest init [APIKEY]

Verá:

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

Resolución de problemas

No entorno de desarrollo

Problema: Ni Xcode ni Android SDK se detectaron.

Solución:

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

ID de la aplicación ya está tomado

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

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

Falta el script de compilación

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

Solución: Agregue un script de construcción a su 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 code manualmente 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:

Desplegar 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 Actualizaciones

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

Obtener Ayuda

Si encuentra problemas durante el proceso de incorporación:

• Verifique el Guía de Solución de Problemas
• Únete a la Comunidad de Discord
• Revisa el FAQ
• Contactar 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 API Overview API Visión General para obtener detalles de implementación en __CAPGO_KEEP_0__ Visión General Introducción API Keys API Claves para obtener detalles de implementación en __CAPGO_KEEP_0__ Claves para el detalle de implementación en Dispositivos, y Packages para el detalle de implementación en Packages.