CLI-Onboarding-Anleitung

Abschnitt mit dem Titel „Schnelle Übersicht“

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. 🔌 Installieren und konfigurieren Sie die Updater-Plugin
3. 🚀 Bereitstellen Sie Ihre erste Live-Update
4. 📱 Testen Sie die Aktualisierung auf Ihrem Gerät

Schätzung der Zeit: 10-20 Minuten (variiert je nach Internet-Geschwindigkeit und Build-Zeit)

Tip

Die Einrichtung ist vollständig wiederholbar - beenden Sie jederzeit und setzen Sie später fort, wo Sie aufgehört haben.

Starten der Einrichtung

Laufen Sie den Einrichtungsbefehl mit Ihrem API-Schlüssel aus:

npx @capgo/cli@latest init [APIKEY]

Sie sehen die Begrüßungsnachricht:

Capgo onboarding 🛫

Was passiert während der Einrichtung?

Die CLI führt Sie durch 13 interaktive Schritte:

Setup-Phase (Schritte 1-6):

• Überprüfen Sie Ihr Entwicklungsumfeld (Xcode/Android Studio)
• Fügen Sie Ihre App zu Capgo hinzu und erstellen Sie einen Produktionskanal
• Installieren Sie das @capgo/capacitor-updater Plugin
• Injectieren Sie das erforderliche code in Ihre App
• Optionell Ende-zu-Ende-Verschlüsselung aktivieren
• Wählen Sie eine Plattform für die Testung (iOS oder Android)

Testphase (Schritte 7-12):

• Bauen Sie Ihre App und führen Sie sie auf einem Gerät/Emulator aus
• Machen Sie eine sichtbare code Änderung (automatisch oder manuell)
• Laden Sie die aktualisierte Bundle auf Capgo hoch
• Sie sehen die Live-Update auf Ihrem Gerät in Echtzeit erscheinen

Abschluss (Schritt 13):

• Ihre App ist bereit für Live-Updates! 🎉

Der 13-Schrittige Einrichtungsprozess

Schritt 1: Überprüfen Sie die Voraussetzungen

Die CLI überprüft Ihre Entwicklungsumgebung, um sicherzustellen, dass Sie die erforderlichen Tools installiert haben.

Was wird überprüft:

• Xcode (nur macOS) - für die iOS-Entwicklung
• Android SDK - für die Android-Entwicklung

Mögliche Ergebnisse:

✅ Beide Umgebungen gefunden:

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

⚠️ Keine Umgebung gefunden:

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

Fragen, die Sie gestellt werden könnten:

Vorsicht

Wenn kein Entwicklungsumfeld ermittelt wird, werden Sie gefragt, ob Sie fortfahren möchten. Es wird empfohlen, mindestens eine Plattform voranzubringen.

Schritt 2: Hinzufügen Ihres Apps

Der CLI wird Sie in Capgo anmelden und Ihre App Ihrem Konto hinzufügen.

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

❓ Add {appId} in Capgo?

Wenn Ihr App-ID bereits vergeben ist:

Der CLI wird Alternativen vorschlagen:

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

Sie können eine Vorschlag auswählen oder eine benutzerdefinierte App-ID eingeben.

Anmerkung

App-IDs müssen in umgekehrter Domänennotation folgen (z.B. com.example.myapp)

Schritt 3: Erstellen Sie einen Produktionskanal

Kanäle ermöglichen Ihnen, verschiedene Update-Ströme für Ihre App zu verwalten.

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

Tipp

Keine Sorge! Dies ist nur für lokale Tests während der Einrichtung gedacht. Das Erstellen eines ‘Produktionskanals’ bedeutet nicht, dass Ihre Updates sofort an Kunden ausgerollt werden. Sie haben die volle Kontrolle darüber, wann Updates bereitgestellt werden. Wählen Sie Ja solange Sie spezifische Kanal-Anforderungen haben.

Wenn Sie Ja auswählen:

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

Ein Produktionskanal wird erstellt und als Standardkanal festgelegt. Dies ist die empfohlene Option für die meisten Benutzer.

Wenn Sie Nein auswählen:

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

Sie müssen die Kanäle später manuell erstellen und konfigurieren. Alternativ können Sie:

• Den Kanal in Ihrem capacitor.config.ts Datei
• Verwenden Sie die JavaScript setChannel() Methode, um den Kanal dynamisch festzulegen
• Kanäle später über die Capgo Web-Konsole konfigurieren

Schritt 4: Installieren Sie den Updater-Plugin

Der CLI installiert das @capgo/capacitor-updater Plugin, das mit Ihrer Capacitor-Version kompatibel ist.

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

Versionen, die kompatibel sind:

• Capacitor 5__CAPGO_KEEP_0__ 5: Installiert @capgo/capacitor-updater v5
• Capacitor 6__CAPGO_KEEP_0__ 6: Installiert @capgo/capacitor-updater v6
• Capacitor 7: Installiert @capgo/capacitor-updater v7
• Capacitor 8+: Installiert die neueste Version

Vorsicht

Capgo unterstützt nur Capacitor ab Version v5. Wenn Sie eine ältere Version verwenden, müssen Sie sich zuerst aktualisieren.

Option für Instant-Updates:

Nach der Installation werden Sie gefragt:

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

Tip

Welche sind Instant-Updates? Mit Instant-Updates aktiviert, wird Ihre App Updates sofort anwenden, wenn sie im Hintergrund läuft und wieder geöffnet wird. Dies funktioniert reibungslos, weil Capgo Updates weltweit in weniger als 300ms verteilen kann. Ohne es (Standardmodus), laden Updates im Hintergrund herunter und werden auf dem nächsten App-Neustart angewendet. Instant-Updates sind großartig für schnellere Iterationen während der Entwicklung und kritische Fehlerbehebungen in der Produktion.

Wenn Sie Ja wählen:

• Updates werden so konfiguriert, dass sie sofort angewendet werden, wenn die App im Hintergrund läuft und wieder geöffnet wird
• autoUpdate: 'always' und autoSplashscreen: true werden
• zu Ihrer Konfiguration hinzugefügt capacitor.config.ts Ihr
• werden automatisch aktualisiert Deltas-Updates

werden automatisch aktiviert - dies sendet nur die Dateien, die zwischen den Updates geändert wurden, anstatt die vollständige Bundle, was die Updates viel schneller macht

• Updates werden die Standardverhalten verwenden (Hintergrundherunterladen, Anwendung bei der nächsten Neustart)
• Sie können Instant-Updates später immer noch aktivieren, indem Sie Ihre capacitor.config.ts

Schritt 5: Hinzufügen der Integration Code

Die CLI wird automatisch die erforderlichen code in Ihre Hauptanwendungsdatei einfügen.

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

Was wird hinzugefügt:

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

CapacitorUpdater.notifyAppReady()

Projekttyp-Detektion:

• Nuxt.js: Erstellt plugins/capacitorUpdater.client.ts
• Andere Frameworks: Fügt Ihrem Haupteingangsdatei hinzu

Tip

Wenn die automatische Einfügung fehlschlägt, können Sie den code manuell in Ihrer Hauptanwendungsdatei hinzufügen:

Für Nuxt.js: Erstellen plugins/capacitorUpdater.client.ts:

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

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

Für andere Frameworks: Fügen Sie dies in Ihre Haupteingangsdatei (z.B. ein Beispiel) ein: main.ts, index.js, App.tsx):

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

CapacitorUpdater.notifyAppReady()

Platzieren Sie den code nach Ihren Imports und vor der App-Initialisierung. Weitere Informationen finden Sie unter Anwendung hinzufügen-Leitfaden.

Schritt 6: Verschlüsselung einrichten (Optional)

End-to-end-Verschlüsselung fügt einem zusätzlichen Sicherheitslevel für Ihre Updates hinzu.

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

Hinweis

Verschlüsselung ist nur für Capacitor v6 und höher verfügbar.

Wenn Sie die Verschlüsselung aktivieren, wird der CLI Folgendes tun:

1. Verschlüsselungs-Schlüssel generieren
2. Angebot, Ihre Capacitor-Konfiguration zu synchronisieren

Schritt 7: Plattform auswählen

Wählen Sie während des Einrichtungsprozesses die Plattform aus, mit der getestet werden soll.

📱 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

Tipps

Dies beeinflusst nur den Einrichtungsprozess. Ihre endgültige App unterstützt alle Plattformen.

Schritt 8: Ihr Projekt erstellen

Die CLI wird Ihr App erstellen und synchronisieren mit Capacitor.

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

Was passiert:

1. Ermittelt den Projekttyp
2. Läuft Ihr Build-Script aus
3. Ausführt npx cap sync {platform}

Wenn Build-Script fehlt:

Sie werden gefragt, ob Sie den Build überspringen oder ein Build-Script zu Ihrem Projekt hinzufügen möchten. package.json.

Schritt 9: Auf Gerät ausführen

Testen Sie die erste Version Ihrer App auf einem Gerät oder Simulator.

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

Wenn Sie wählen Ja:

(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

Schritt 10: Änderung vornehmen

Jetzt ist es Zeit, das Update-System von Capgo zu testen, indem man eine sichtbare Änderung vornimmt.

🎯 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

Automatikmodus: Das CLI wird automatisch Ihre Dateien ändern, um eine sichtbare Testbanner oder Änderung hinzuzufügen.

Manueller Modus: Sie machen Ihre eigenen Änderungen (z.B. Text, Farben oder hinzufügen von Elementen).

Versionsverwaltung:

❓ 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

Mit Änderungen bauen:

❓ Build {appId} with changes before uploading?

Hinweis

Wenn Sie manuell in einem anderen Terminal bauen müssen, wählen Sie "Nein" und bauen Sie selbst, dann können Sie fortfahren.

Schritt 11: Hochladen des Bundles

Hochladen Sie Ihr aktualisiertes App-Bundle auf Capgo.

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

Die CLI läuft:

npx @capgo/cli@latest bundle upload

Hinweis

Delta-Updates mit sofortigen Updates: Wenn Sie in Schritt 4 die sofortigen Updates aktiviert haben, fragt der CLI automatisch, ob Sie Delta-Updates aktivieren möchten. Delta-Updates senden nur die Dateien, die zwischen den Versionen geändert wurden, anstatt das gesamte Bundle. Da normalerweise nur wenige Dateien zwischen den Updates geändert werden, macht dies die Downloads viel schneller. Wählen Sie Ja für die beste Erfahrung mit sofortigen Updates.

Delta-Updates-Angebot (wenn ein Instant-Apply-Modus aktiviert ist):

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

Vorsicht

Für Monorepos müssen Sie möglicherweise zusätzliche Pfade zu Ihren package.json und node_modules.

Erfolg:

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

Schritt 12: Testen Sie die Aktualisierung auf dem Gerät

Jetzt sehen Sie die Aktualisierung in Aktion!

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

Für sofortige Aktualisierungen:

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

Für Standardaktualisierungen:

📱 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

Protokollieren Sie die Ausgaben:

❓ Monitor Capgo logs to verify the update worked?

Wenn Sie "Ja" auswählen, Sie sehen live die Protokolle Ihres Geräts, die den Aktualisierungsprozess anzeigen.Wenn Sie "Ja" auswählen, sehen Sie live die Protokolle Ihres Geräts, die den Aktualisierungsprozess anzeigen.

Schritt 13: Abschluss

Welcome onboard ✈️!

Herzlichen Glückwunsch! Sie haben erfolgreich Capgo-Live-Updates für Ihre App eingerichtet.

Was Sie erreicht haben

Nach Abschluss der Einrichtung haben Sie:

✅ App registriert

Ihre App ist in Capgo mit einem Produktionskanal registriert

✅ Plugin installiert

Das Capacitor-Updater-Plugin ist installiert und konfiguriert

✅ Code integriert

Integration code wird in Ihre App hinzugefügt

✅ Aktualisiert getestet

Sie haben erfolgreich deployt und erhalten ein Live-Update erhalten

Tägliche Workflow

Für weitere Updates verwenden Sie:

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

Für weitere Bereitstellungsoptionen siehe Ein Live-Update bereitstellen.

Wiederaufnahme der Einrichtung

Wenn Sie das Einrichtungsprozess verlassen, können Sie ihn jederzeit fortsetzen:

npx @capgo/cli@latest init [APIKEY]

Sie sehen:

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

Tipps

Der Fortschritt wird lokal gespeichert, sodass Sie den Einrichtungsprozess sicher verlassen und ihn jederzeit fortsetzen können.

Fehlersuche

Keine Entwicklungsumgebung

Problem: Xcode oder Android SDK wurde nicht erkannt.

Lösung:

• Für iOS: Installiere Xcode (nur macOS)
• Für Android: Installiere Android Studio

App-ID bereits vergeben

Problem: Ihre App-ID ist bereits registriert.

Lösung: Wählen Sie eine der vorgeschlagenen Alternativen oder geben Sie eine benutzerdefinierte App-ID in umgekehrter Domänennotation ein.

Build Script fehlt

Problem: Kein Build-Script in package.json.

Lösung: Fügen Sie ein Build-Script zu Ihrem package.json:

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

Auto-Injektion fehlgeschlagen

Problem: CLI kann die Integration code nicht automatisch einbinden.

Lösung: Fügen Sie code manuell in Ihre Hauptdatei ein:

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

CapacitorUpdater.notifyAppReady()

Capacitor-Version zu alt

Problem: Ihre Capacitor-Version liegt unter v5.

Lösung: Aktualisieren Sie Capacitor auf v5 oder höher:

• Upgrade auf Capacitor 5
• Upgrade auf Capacitor 6
• Upgrade auf Capacitor 7

Zukünftige Schritte

Erkunden Sie nun diese Themen:

Einstellungshinweis für einmalige Anpassungen

Konfigurieren Sie Kanäle, CI und Delta-Upload einmalig für langfristige Stabilität

Bereitstellung von Updates

Erhalten Sie Informationen zur Bereitstellung von Updates über das Capgo-Dashboard

Update-Typen

Verweis auf alle OTA-Update-Typen: Anwendungszeitpunkt, Verzögerungsbedingungen, Versionsblockierung und Lieferung

CI/CD-Integration

Automatisieren Sie Ihre Update-Deployments mit CI/CD

Kanäle

Verwalten Sie mehrere Update-Streams mit Kanälen

Verschlüsselung

Sichern Sie Ihre Updates mit Ende-zu-Ende-Verschlüsselung

Update-Verhalten

Anpassen Sie, wann und wie Updates angewendet werden (direkt, Delta usw.)

Hilfe

Überprüfen Sie die

• __CAPGO_KEEP_0__ Troubleshooting Guide
• Sich dem Community anschließen Discord Community
• Die FAQ überprüfen FAQ
• Kontaktieren Sie uns Kontakt

Keep going from CLI Onboarding Guide

Fortsetzung vom __CAPGO_KEEP_0__ Einrichtungsleitfaden Fortsetzung vom CLI Einrichtungsleitfaden Wenn Sie API Einrichtungsleitfaden verwenden, um das Dashboard zu planen und API-Operationen durchzuführen, verbinden Sie es mit API Übersicht für die Implementierungsdetails in API Übersicht Einführung für die Implementierungsdetails in Einführung API Schlüssel für die Implementierungsdetails in API Schlüssel Geräte für die Implementierungsdetails in Geräte und Pakete für die Implementierungsdetails in Pakete.