CLI Einrichtungsleitfaden

Schnelle Übersicht

Das Capgo CLI bietet eine interaktive Einsteiger-Tour, die für Ihre Capacitor-App lebendige Updates einrichtet. Sie werden:

1. ✅ Ihre App bei Capgo registrieren
2. 🔌 Den Updater-Plugin installieren und konfigurieren
3. 🚀 Ihre erste lebendige Aktualisierung bereitstellen
4. 📱 Die Aktualisierung auf Ihrem Gerät testen

Geschätzte Zeit: 10-20 Minuten (abhängig von Ihrer Internetgeschwindigkeit und der Aufbauzeit)

Tip

Die Onboarding-Prozess ist vollständig wieder aufnehmbar - Sie können jederzeit aussteigen und später von dem Punkt fortsetzen, an dem Sie aufgehört haben.

Starten Sie das Onboarding

Führen Sie den Onboarding-Befehl mit Ihrem API-Schlüssel aus:

npx @capgo/cli@latest init [APIKEY]

Sie sehen die Begrüßungsmitteilung:

Capgo onboarding 🛫

Was Während des Onboarding-Gangs Geschieht

The CLI wird Sie durch 13 interaktive Schritte führen:

Einstellungsbereich (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
• Optional aktivieren Sie Ende-zu-Ende-Verschlüsselung
• 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 das aktualisierte Bundle bei Capgo hoch
• Sie sehen das lebendige Update auf Ihrem Gerät in Echtzeit erscheinen

Abschluss (Schritt 13):

• Ihr App ist bereit für lebendige Updates! 🎉

Der 13-Schrittige Einrichtungsprozess

Schritt 1: Überprüfen Sie die Voraussetzungen

Das CLI überprüft Ihre Entwicklungsumgebung, um sicherzustellen, dass alle notwendigen Tools installiert sind.

Überprüft werden:

• Xcode (nur macOS) - für iOS-Entwicklung
• Android SDK - für 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 keine Entwicklungsumgebung ermittelt wird, werden Sie gefragt, ob Sie fortfahren möchten. Es wird empfohlen, mindestens eine Plattform vorher zu installieren.

Schritt 2: Hinzufügen Ihrer App

Der CLI wird Sie in Capgo anmelden und Ihre App Ihrem Account 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 oder eine benutzerdefinierte App-ID auswählen.

Hinweis

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

Schritt 3: Erstellen Sie einen Produktionskanal

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

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

Tipp

Machen Sie sich keine Sorgen! Dies ist nur für lokale Tests während der Einrichtung gedacht. Die Erstellung eines "Produktions"-Kanals bedeutet nicht, dass Ihre Updates sofort an Kunden ausgerollt werden. Wählen Sie Ja es sei denn, Sie haben spezifische Anforderungen an Kanäle.

Wenn Sie Ja wä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 wä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:

• Legen Sie den Kanal in Ihrem capacitor.config.ts Datei
• Verwenden Sie die JavaScript setChannel() Methode, um den Kanal dynamisch zu setzen
• Kanäle später von der Capgo Web-Konsole konfigurieren

Schritt 4: Updater-Plugin installieren

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

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

Versionskompatibilität:

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

Achtung

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

Option für sofortige Aktualisierungen:

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

Tipp

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

Wenn Sie Ja auswählen:

• Aktualisierungen werden so konfiguriert, dass sie sofort anwenden, wenn die App im Hintergrund läuft und wieder geöffnet wird
• autoUpdate: 'always' und autoSplashscreen: true wird in Ihre Konfiguration aufgenommen
• Ihr capacitor.config.ts wird automatisch aktualisiert
• Delta-Updates werden automatisch aktiviert - dies sendet nur die Dateien, die sich zwischen den Updates geändert haben, anstatt des gesamten Bundles, was die Updates viel schneller macht

Wenn Sie "Nein" auswählen:

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

Schritt 5: Hinzufügen der Integration Code

Der CLI wird die erforderlichen code automatisch 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 Haupt-Einstiegsskript hinzu

Tipp

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

For Nuxt.js: Erstellen plugins/capacitorUpdater.client.ts:

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

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

Für andere Frameworks: Hinzufügen Sie es zu Ihrem Haupt-Einstiegsskript (z.B. main.ts, index.js, App.tsx):

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

CapacitorUpdater.notifyAppReady()

Platzieren Sie dies code nach Ihren Imports und vor der Initialisierung Ihrer App. Weitere Details finden Sie im Hinzufügen Sie eine App-Leitfaden.

Schritt 6: Verschlüsselung einrichten (Optional)

End-to-end-Verschlüsselung fügt einem zusätzlichen Sicherheitslayer 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

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

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

1. Schlüssel für die Verschlüsselung generieren
2. Angebot, die Konfiguration des Capacitor zu synchronisieren

Schritt 7: Plattform auswählen

Wählen Sie die Plattform für die Testphase während der Einrichtung.

📱 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

Tipp

Das betrifft nur den Einrichtungsprozess. Ihre endgültige App unterstützt alle Plattformen.

Schritt 8: Erstellen Sie Ihr Projekt

Der CLI wird Ihr App erstellen und mit Capacitor synchronisieren.

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

Was passiert:

1. Ermittelt den Projekttyp
2. Führt Ihren 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: Ausführen auf Gerät

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 auswä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 zum Testen vornehmen

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

🎯 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).

Versionshandling:

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

Tipp

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: Upload Bundle

Laden Sie Ihr aktualisiertes App-Bundle bei Capgo hoch.

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

Der CLI läuft:

npx @capgo/cli@latest bundle upload

Tipp

Delta-Updates mit Instant-Updates: Wenn Sie in Schritt 4 Instant-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 den gesamten Bundle. Da normalerweise nur wenige Dateien zwischen den Updates geändert werden, macht dies die Downloads viel schneller. Wählen Sie Ja für das beste Erlebnis mit Instant-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)

Achtung

Für Monorepos müssen Sie möglicherweise zusätzliche Pfade zu Ihrem 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

Protokolle überwachen:

❓ Monitor Capgo logs to verify the update worked?

Wenn Sie wählen Ja, sehen Sie lebende Protokolle von Ihrem Gerät, 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

Der Capacitor-Updater-Plugin ist installiert und konfiguriert

✅ Code Integriert

Die Integration von code wurde in Ihre App hinzugefügt

✅ Update Getestet

Sie haben erfolgreich ein Live-Update bereitgestellt und erhalten haben

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 Einrichtungsverfahren verlassen, können Sie jederzeit fortfahren:

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?

Tip

Der Fortschritt wird lokal gespeichert, sodass Sie sicher aussteigen und den Onboarding-Prozess fortsetzen können.

Troubleshooting

Kein Entwicklungsumgebung

Problem: Kein Xcode- oder Android-SDK-Entdecker wurde gefunden.

Lösung:

• Für iOS:: Install Xcode (macOS nur)
• Für Android: Installieren 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-Skript fehlt

Problem: Kein Build-Skript in " package.json.

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

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

Auto-Injektion fehlgeschlagen

Problem: CLI kann die Integration code nicht automatisch einfügen.

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: Capacitor auf v5 oder höher updaten:

• Capacitor auf Version 5 updaten
• Capacitor auf Version 6 updaten
• Capacitor auf Version 7 updaten

Nächste Schritte

Now that you’ve completed onboarding, explore these topics:

Updates bereitstellen

Erhalten Sie eine Anleitung, wie Sie Updates aus der Capgo-Oberfläche bereitstellen können

Update-Typen

Referenz aller 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-Ströme mit Kanälen

Verschlüsselung

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

Update-Verhalten

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

Hilfe erhalten

Wenn Sie während der Einrichtung Probleme auftreten:

• Überprüfen Sie die Troubleshooting-Anleitung
• Teilen Sie sich mit der Discord-Gemeinschaft
• Überprüfen Sie die FAQ
• Kontakt Support

Bleib am Ball von CLI Einrichtungsleitfaden

Wenn Sie "__CAPGO_KEEP_0__ Einrichtungsleitfaden" verwenden CLI Einrichtungsleitfaden um das Dashboard und die API-Operationen zu planen, 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äten und Bündel Seite bearbeiten