CLI Guide de mise en route

Vue d'ensemble rapide

Le Capgo CLI fournit une onboarding interactive qui configure les mises à jour en direct pour votre Capacitor application. Vous allez :

1. ✅ Enregistrer votre application dans Capgo
2. 🔌 Installer et configurer le plugin de mise à jour
3. 🚀 Déployer votre première live update
4. 📱 Tester l'actualisation sur votre appareil

Temps estimé : 10-20 minutes (varie en fonction de votre vitesse d'internet et du temps de construction)

Conseil

L'inscription est pleinement résumable - quittez à tout moment et continuez plus tard à partir de l'endroit où vous avez laissé.

Lancer l'inscription

Exécutez la commande d'inscription avec votre clé API :

npx @capgo/cli@latest init [APIKEY]

Vous verrez le message d'accueil :

Capgo onboarding 🛫

Ce qui se passe lors de l'inscription

Le CLI vous guidera à travers 13 étapes interactives :

Phase de configuration (Étapes 1-6) :

• Vérifiez votre environnement de développement (Xcode/Android Studio)
• Ajoutez votre application à Capgo et créez un canal de production
• Installez le @capgo/capacitor-updater plugin
• Injectez les code requis dans votre application
• Activez l'encryption fin-à-fin (optionnel)
• Choisissez une plateforme pour les tests (iOS ou Android)

Phase d'essai (Étapes 7-12) :

• Construirez votre application et l'exécutez sur un appareil/simulateur
• Apportez une modification visible (code) (automatique ou manuelle)
• Envoyez le bundle mis à jour vers (Capgo)
• Voyez le (live update) apparaître sur votre appareil en temps réel

Terminaison (Étape 13) :

• Your app is ready for live updates! 🎉

Le processus d'inscription en 13 étapes

Étape 1 : Vérifiez les prérequis

Le CLI vérifie votre environnement de développement pour vous assurer que vous disposez des outils nécessaires installés.

Ce qui est vérifié :

• Xcode (seulement macOS) - pour le développement iOS
• Android SDK - pour le développement Android

Résultats possibles :

✅ Les deux environnements trouvés :

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

⚠️ Aucun environnement trouvé :

⚠️ 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

Questions auxquelles vous pourriez être posées :

Attention

Si aucun environnement de développement n'est détecté, vous serez invité à continuer. Il est recommandé d'installer au moins une plateforme avant de poursuivre.

Étape 2 : Ajoutez votre application

Le CLI vous connectera à Capgo et ajoutera votre application à votre compte.

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

❓ Add {appId} in Capgo?

Si votre ID d'application est déjà pris :

Le CLI suggérera des alternatives :

❌ 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?

Vous pouvez choisir une suggestion ou saisir un ID d'application personnalisé.

Note

App IDs must follow reverse domain notation (e.g., com.example.myapp)

Étape 3 : Créer un canal de production

Les canaux vous permettent de gérer différents flux d'actualisation pour votre application.

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

Conseil

Ne vous inquiétez pas ! Ceci est juste pour les tests locaux pendant l'inscription. La création d'un 'canal de production' ne signifie pas que vos mises à jour seront mises en ligne auprès des clients immédiatement. Vous avez un contrôle total sur la mise en ligne des mises à jour. Sélectionnez Oui sauf si vous avez des exigences spécifiques de canal.

Si vous sélectionnez Oui :

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

Un canal de production sera créé et défini par défaut. C'est la recommandation pour la plupart des utilisateurs.

Si vous sélectionnez Non :

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

Vous devrez créer et configurer les canaux manuellement plus tard. Alternativement, vous pouvez :

• Définir le canal dans votre capacitor.config.ts fichier
• Utilisez le JavaScript setChannel() méthode pour définir dynamiquement le canal
• Configurez les canaux plus tard depuis l'interface web Capgo.

Étape 4 : Installer le Plugin de Mise à Jour

Mise à jour CLI installera le @capgo/capacitor-updater plugin compatible avec votre version Capacitor.

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

Compatibilité de la version :

• Capacitor 5 : Installe @capgo/capacitor-updater v5
• Capacitor 6 : Installe @capgo/capacitor-updater v6
• Capacitor 7 : Installe @capgo/capacitor-updater v7
• Capacitor 8+: Installe la dernière version

Attention

Capgo ne prend en charge que Capacitor v5 et ultérieur. Si vous utilisez une version plus ancienne, vous devrez d'abord la mettre à jour.

Option d'actualisation instantanée :

Après l'installation, vous serez interrogé(e) :

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

Conseil

Qu'est-ce que les mises à jour instantanées ? Avec les mises à jour instantanées activées, votre application applique les mises à jour immédiatement lorsque l'application est en arrière-plan et est rouvert. Cela fonctionne de manière fluide car Capgo peut distribuer les mises à jour dans le monde entier en moins de 300 ms. Sans cela (mode standard), les mises à jour téléchargent en arrière-plan et s'appliquent à la prochaine redémarrage de l'application. Les mises à jour instantanées sont excellentes pour une itération plus rapide pendant le développement et les correctifs critiques en production.

Si vous sélectionnez Oui :

• Les mises à jour seront configurées pour s'appliquer immédiatement lorsque l'application est en arrière-plan et est rouvert
• autoUpdate: 'always' et autoSplashscreen: true seront ajoutés à votre configuration
• @capacitor/splash-screen seront installés si manquants, avec launchAutoHide: false
• Votre capacitor.config.ts seront mis à jour automatiquement
• Mises à jour delta restent activées. Instant apply (always, atInstall, onLaunchdevrait continuer à utiliser npx @capgo/cli@latest bundle upload --delta ainsi que seuls les fichiers modifiés téléchargent et l'utilisateur n'est pas laissé attendre sur un zip complet

If vous sélectionnez Non:

• Mises à jour utiliseront le comportement standard (téléchargement en arrière-plan, application à la prochaine redémarrage)
• Vous pouvez toujours activer les mises à jour instantanées plus tard en modifiant votre capacitor.config.ts

Étape 5 : Ajouter l'intégration Code

Le CLI injectera automatiquement les code requis dans votre fichier d'application principal.

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

Ce qui est ajouté :

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

CapacitorUpdater.notifyAppReady()

La détection du type de projet :

• Nuxt.js: Crée plugins/capacitorUpdater.client.ts
• Autres frameworks: Ajoutez-l’à votre fichier d'entrée principal

Conseil

Si l'injection automatique échoue, vous pouvez ajouter manuellement le code à votre fichier d'application principal :

Pour Nuxt.js : Créer plugins/capacitorUpdater.client.ts:

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

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

Pour d'autres frameworks : Add to your main entry file (e.g., main.ts, index.js, App.tsx):

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

CapacitorUpdater.notifyAppReady()

Placez ce code après vos imports et avant l'initialisation de votre application. Pour plus de détails, consultez le Guide d'ajout d'une application.

Étape 6 : Configuration de l'encodage (Facultatif)

Section intitulée « Étape 6 : Configuration de l'encodage (Facultatif) »

🔐 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?

Note

La cryptage est uniquement disponible pour Capacitor v6 et versions ultérieures.

L'encodage n'est disponible que pour CLI v6 et au-dessus.

1. Si vous activez l'encodage, le __CAPGO_KEEP_0__ fera :
2. Proposez de synchroniser votre configuration Capacitor.

Étape 7 : Sélectionner la plateforme

Choisissez la plateforme pour tester pendant le processus d'inscription.

📱 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

Conseil

Cela n'affecte que le processus d'inscription. Votre application finale prendra en charge toutes les plateformes.

Étape 8 : Construire votre projet

Le CLI construira votre application et la synchronisera avec Capacitor.

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

Ce qui se passe :

1. Détecte votre type de projet
2. Exécute votre script de construction
3. Exécute npx cap sync {platform}

Si le script de construction est manquant :

Vous serez interrogé sur la possibilité de sauter la construction ou d'ajouter un script de construction à votre package.json.

Étape 9 : Exécution sur appareil

Testez la première version de votre application sur un appareil ou un simulateur.

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

Si vous sélectionnez Oui:

(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

Étape 10 : Apportez une modification de test

Now it’s time to test Capgo’s update system by making a visible change.

🎯 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

Mode automatique : Le CLI modifiera automatiquement vos fichiers pour ajouter un bandeau de test visible ou une modification.

Mode manuel : You make your own changes (e.g., change text, colors, or add elements).

Gestion de version :

❓ 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

Construire avec les modifications :

❓ Build {appId} with changes before uploading?

Conseil

Si vous devez construire manuellement dans un autre terminal, sélectionnez « Non » et construisez vous-même, puis continuez.

Étape 11 : Télécharger le Bundle

Charger votre bundle d'application mise à jour sur Capgo.

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

Le CLI s'exécute :

npx @capgo/cli@latest bundle upload

Conseil

Mises à jour Delta avec mises à jour instantanées : Si vous avez activé les mises à jour instantanées dans l'étape 4, le CLI demandera automatiquement si vous souhaitez activer les mises à jour Delta. Les mises à jour Delta envoient uniquement les fichiers qui ont changé entre les versions au lieu de l'intégralité du bundle. Puisque généralement, seuls quelques fichiers changent entre les mises à jour, cela accélère considérablement les téléchargements. Sélectionnez Oui Pour une expérience optimale avec les mises à jour instantanées.

Mise à jour Delta (si un mode d'application instantanée est activé) :

💡 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)

Attention

Pour les monorepos, vous devrez peut-être fournir des chemins supplémentaires à vos package.json et node_modules.

Réussi :

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

Étape 12 : Testez l'actualisation sur le dispositif

Le moment de voir la mise à jour en action !

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

Pour des mises à jour instantanées :

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

Pour des mises à jour standard :

📱 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

Surveiller les journaux :

❓ Monitor Capgo logs to verify the update worked?

Si vous sélectionnez Oui, vous verrez des journaux en direct de votre appareil montrant le processus d'actualisation.

Étape 13 : Complétion

Welcome onboard ✈️!

Félicitations ! Vous avez réussi à configurer les mises à jour en direct Capgo pour votre application.

Ce que vous avez accompli

Après avoir terminé l'inscription, vous avez :

✅ L'application enregistrée

Votre application est enregistrée dans Capgo avec un canal de production

✅ Plugin installé

Le plugin d'actualisation Capacitor est installé et configuré

✅ Code Intégré

L'intégration code est ajoutée à votre application

✅ Mise à jour Testée

Vous avez réussi à déployer et reçu un live update

Flux quotidien

Pour les mises à jour ultérieures, utilisez :

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

Pour plus d'options de déploiement, voir Déployer un Live Update.

Reprise de l'inscription

Si vous quittez le processus d’onboarding, vous pouvez le reprendre à tout moment :

npx @capgo/cli@latest init [APIKEY]

Vous verrez :

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

Conseil

Le progrès est sauvegardé localement, vous pouvez donc sortir en toute sécurité et reprendre le processus d’onboarding.

Troubleshooting

Aucun environnement de développement

Problème : Ni Xcode ni Android SDK n'est détecté.

Solution :

• Pour iOS: Installez Xcode (seulement macOS)
• Pour Android: Installez Android Studio

ID d'application déjà pris

Problème : Votre ID d’application est déjà enregistré.

Solution : Choisissez l’une des alternatives suggérées ou entrez un ID d’application personnalisé en notation de domaine inversé.

Script de construction manquant

Problème : Aucun script de construction trouvé dans package.json.

Solution : Ajoutez un script de construction à votre package.json:

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

Injection automatique échouée

Problème : CLI ne peut pas injecter automatiquement l'intégration code.

Solution : Ajoutez code manuellement à votre fichier principal :

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

CapacitorUpdater.notifyAppReady()

Capacitor Version trop ancienne

Problème : Votre version de Capacitor est inférieure à v5.

Solution : Mettre à jour Capacitor vers v5 ou supérieur :

• Mettre à jour Capacitor 5
• Mettre à jour Capacitor 6
• Mettre à jour Capacitor 7

Étapes suivantes

Maintenant que vous avez terminé l'inscription, explorez ces sujets :

Liste de vérification de configuration unique

Configurez les canaux, CI et l'envoi delta une fois pour une stabilité à long terme.

Déployer les mises à jour

Apprenez à déployer des mises à jour depuis le tableau de bord Capgo.

Types de mise à jour

Référence de tous les types d'actualisations OTA : application de timing, conditions de retard, blocage de version et livraison

Intégration CI/CD

Automatisez vos déploiements d'actualisations avec CI/CD

Canaux

Gérer plusieurs flux d'actualisations avec les canaux

Chiffrement

Protégez vos actualisations avec un chiffrement de bout en bout

Comportement d'actualisation

Personnalisez quand et comment les actualisations sont appliquées (direct, delta, etc.)

Obtenez de l'Aide

Si vous rencontrez des problèmes lors de l'inscription :

• Vérifiez le Guide de dépannage
• Rejoignez la Communauté Discord
• Examinez le FAQ
• Contactez Aide

Continuez de CLI Guide d'inscription

Si vous utilisez CLI Onboarding Guide planifier le tableau de bord et les opérations API, le connecter avec Vue d'ensemble de API pour les détails d'implémentation dans la Vue d'ensemble de API, Introduction pour les détails d'implémentation dans l'Introduction, Clés de API pour les détails d'implémentation dans les Clés de API, Appareils pour les détails d'implémentation dans les Appareils, et Ensembles pour les détails d'implémentation dans les Ensembles.