CLI Onboarding Guide

Schnelle Übersicht

Das Capgo CLI bietet eine interaktive Einrichtung, die für Ihr Capacitor-Anwendungsprogramm lebendige Updates einrichtet. Sie werden:

1. ✅ Ihr Anwendungsprogramm in Capgo registrieren
2. 🔌 Die Updater-Plugin installieren und konfigurieren
3. 🚀 Ihr erstes lebendiges Update bereitstellen
4. 📱 Die Aktualisierung auf Ihrem Gerät testen

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

Tipp

Die Einrichtung ist vollständig wieder aufnehmbar - beenden Sie das Programm jederzeit und setzen Sie es später fort, wo Sie aufgehört haben.

Einrichtung starten

Führen 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?

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

Einrichtungsphase (Schritte 1-6):

• Überprüfen Sie Ihr Entwicklungsumfeld (Xcode/Android Studio)
• Fügen Sie Ihre App an Capgo hinzu und erstellen Sie einen Produktionskanal
• Installieren Sie das @capgo/capacitor-updater Plugin
• Fügen Sie das erforderliche code in Ihre App ein
• Optional End-to-End-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/Simulator 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-Schritte-Startprozess

Schritt 1: Überprüfen Sie die Voraussetzungen

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

Was wurde überprüft:

• 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 kein Entwicklungsumfeld erkannt wird, wird Ihnen nachgefragt, 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 zu 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 einen benutzerdefinierten App-Id eingeben.

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?

Tipps

Machen Sie sich keine Sorgen! Dies ist nur für lokale Tests während der Einrichtung gedacht. Das Erstellen eines "Produktions"-Kanals bedeutet nicht, dass Ihre Updates sofort an Kunden gehen werden. Sie haben die volle Kontrolle darüber, wann Updates bereitgestellt werden. Wählen Sie Ja nicht aus, es sei denn, Sie haben spezifische Kanal-Anforderungen.

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

• Den Kanal in Ihrem capacitor.config.ts Datei
• Verwenden Sie die JavaScript setChannel() Methode, um den Kanal dynamisch festzulegen
• Kanäle später von der Capgo Webkonsole konfigurieren

Schritt 4: Updater-Plugin installieren

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

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

Versionen, mit denen kompatibel ist:

• 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

Vorsicht

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

Option für sofortige 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

Tipps

Was sind sofortige Updates? With instant updates enabled, your app applies updates immediately when backgrounded and reopened. This works seamlessly because Capgo can distribute updates worldwide in under 300ms. Without it (standard mode), updates download in the background and apply on the next app restart. Instant updates are great for faster iteration during development and critical bug fixes in production.

Wenn Sie Ja wählen:

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

Wenn Sie Nein wählen:

• Updates werden die Standardverhalten verwenden (Herunterladen im Hintergrund, Anwenden beim nächsten Neustart)
• Sie können Instant-Updates später immer noch aktivieren, indem Sie Ihre Konfiguration ändern 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 hinzugefügt wird:

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 Injection fehlschlägt, kannst du den code manuell in deine Hauptanwendungsdatei einfü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üge ihn in deine Haupteingangsdatei (z.B. main.ts, index.js, App.tsx):

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

CapacitorUpdater.notifyAppReady()

Platziere den code nach deinen Imports und vor der App-Initialisierung. Weitere Informationen findest du im Hinzufügen einer App-Anleitung.

Schritt 6: Setup Verschlüsselung (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

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

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

1. Erstellt Verschlüsselungsschlüssel
2. Bietet Ihnen an, Ihre Capacitor-Konfiguration zu synchronisieren

Schritt 7: Auswahl der Plattform

Schritt 7: Auswahl der Plattform

📱 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

Tip

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

Schritt 8: Erstellen Sie Ihr Projekt

Der CLI wird Ihr App erstellen und synchronisieren mit Capacitor.

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

Was passiert:

1. Erkennen Sie den Projekttyp
2. Ausführen Ihres Build-Skripts
3. Ausführen npx cap sync {platform}

Wenn der Build-Skript fehlt:

Sie werden gefragt, ob Sie den Build überspringen oder ein Build-Skript 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 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 zum Testen vornehmen

Jetzt ist es Zeit, Capgo's Update-System zu testen, indem Sie eine sichtbare Änderung vornehmen.

🎯 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: Der CLI wird Ihre Dateien automatisch ändern, um eine sichtbare Testbanner oder Änderungen hinzuzufügen.

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

Versionen verwalten:

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

Tip

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

Hochladen Sie Ihr aktualisiertes App-Bundle zu Capgo.

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

Der CLI läuft:

npx @capgo/cli@latest bundle upload

Tipp

Delta-Updates mit sofortigen Updates: Wenn Sie in Schritt 4 sofortige Updates aktiviert haben, wird der CLI automatisch fragen, 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 Herunterladung viel schneller. Wählen Sie Ja für die beste Erfahrung mit sofortigen Updates.

Delta-Updates-Anzeige (wenn eine sofortige Anwendungsmode 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 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

Zeit, die Aktualisierung in Aktion zu sehen!

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

Für sofortige Updates:

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

Für Standard-Updates:

📱 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 "Ja" auswählen, Sie sehen live Protokolle von Ihrem Gerät, die den Update-Prozess anzeigen.Schritt 13: Abschluss

Abschnitt mit dem Titel "Schritt 13: Abschluss"

Welcome onboard ✈️!

Herzlichen Glückwunsch! Sie haben Capgo live Updates erfolgreich 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

Die Integration code wurde in Ihre App hinzugefügt

✅ Update getestet

Sie haben erfolgreich deployt und erhalten ein Live-Update

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 Bereitstellung eines Live-Updates.

Wiederaufnahme der Einrichtung

Wenn Sie den Einrichtungsprozess verlassen, können Sie jederzeit wieder fortfahren:

npx @capgo/cli@latest init [APIKEY]

Du siehst:

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

Tipp

Der Fortschritt wird lokal gespeichert, sodass du sicher aus dem Onboarding-Prozess aussteigen und ihn später fortsetzen kannst.

Fehlersuche

Keine Entwicklungsumgebung

Problem: Kein Xcode- noch kein Android-SDK wurde erkannt.

Lösung:

• Für iOS: Installieren Xcode (nur macOS)
• 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 einen benutzerdefinierten 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 nicht automatisch die Integration code 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: Aktualisieren Sie Capacitor auf v5 oder höher:

• Aktualisierung auf Capacitor 5
• Aktualisierung auf Capacitor 6
• Auf Capacitor 7 aktualisieren

Nächste Schritte

Nachdem Sie die Einrichtung abgeschlossen haben, erkunden Sie diese Themen:

Einmaliger Einrichtungskalender

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

Updates bereitstellen

Erfahren Sie, wie Sie Updates aus der Capgo-Oberfläche bereitstellen

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-Streams mit Kanälen

Verschlüsselung

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

Updateverhalten

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

Hilfe

Wenn Sie bei der Einrichtung Probleme auftreten:

• Überprüfen Sie das Troubleshooting Guide
• Beitreten Sie zum Discord Community
• Review the FAQ
• Kontakt Support

Weitergehen Sie von der CLI-Einführungsanleitung

Wenn Sie __CAPGO_KEEP_0__-Einführungsanleitung CLI-Einführungsanleitung zum Planen von Dashboard und API-Operationen verwenden, 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.