Getting Started
Einen Setup-Vorschlag mit den Installationsanweisungen und der vollständigen Markdown-Anleitung für diesen Plugin kopieren.
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these packages:
- `@capacitor-plus/core`
- `@capacitor-plus/cli`
- `@capacitor-plus/android` if the project targets Android
- `@capacitor-plus/ios` if the project targets iOS
Complete the required Capacitor initialization, platform, sync, native setup, and configuration work.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/capacitor-plus/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
Neuer Projekt-Installation
Abschnitt mit dem Titel „Neuer Projekt-Installation“Sie können unser AI-gestütztes Setup verwenden, um Capacitor+ zu installieren. Fügen Sie den Capgo-Fähigkeiten Ihrer AI-Werkzeug mit der folgenden Befehl hinzu:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-pluginsVerwenden Sie dann die folgende Anweisung:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capacitor-plus/core`, `@capacitor-plus/cli`, `@capacitor-plus/android`, and `@capacitor-plus/ios` packages in my project.Wenn Sie eine manuelle Einrichtung bevorzugen, installieren Sie die Pakete, indem Sie die folgenden Befehle ausführen und folgen Sie den unten aufgeführten Plattform-spezifischen Anweisungen:
-
Kernpaket installieren
Terminal-Fenster npm install @capacitor-plus/core @capacitor-plus/cli -
Plattformpaket hinzufügen
Terminal-Fenster npm install @capacitor-plus/android # for Androidnpm install @capacitor-plus/ios # for iOS -
Initialisieren Sie Capacitor
Terminalfenster npx cap initTerminalfenster pnpm cap initTerminalfenster yarn cap initTerminalfenster bunx cap init -
Plattformen hinzufügen
Terminalfenster npx cap add androidTerminalfenster pnpm cap add androidTerminalfenster yarn cap add androidTerminalfenster bunx cap add androidTerminalfenster npx cap add iosTerminalfenster pnpm cap add iosTerminalfenster yarn cap add iosTerminalfenster bunx cap add ios
Von offiziellem Capacitor auf Capacitor migrieren
Abschnitt mit dem Titel “Von der offiziellen Capacitor migrieren”Wenn Sie ein bestehendes Capacitor-Projekt haben, ist die Migration zu Capacitor+ einfach:
-
Offizielle Pakete entfernen
Terminal-Fenster npm uninstall @capacitor/core @capacitor/cli @capacitor/android @capacitor/ios -
Installieren Sie Capacitor+-Pakete
Terminal-Fenster npm install @capacitor-plus/core @capacitor-plus/clinpm install @capacitor-plus/android # if using Androidnpm install @capacitor-plus/ios # if using iOS -
Synchronisieren Sie Ihr Projekt
Terminalfenster npx cap syncTerminalfenster pnpm cap syncTerminalfenster yarn cap syncTerminalfenster bunx cap sync
Verwendung
Abschnitt: VerwendungSince Capacitor+ is API-compatible, your existing code works without changes:
import { Capacitor } from '@capacitor/core';import { registerPlugin } from '@capacitor/core';
// Check platformconst platform = Capacitor.getPlatform();console.log('Running on:', platform);
// Check if nativeif (Capacitor.isNativePlatform()) { console.log('Running on native platform');}
// Register a custom pluginconst MyPlugin = registerPlugin('MyPlugin');With Official Capacitor Plugins
Section titled “With Official Capacitor Plugins”All official Capacitor plugins work seamlessly:
import { Camera, CameraResultType } from '@capacitor/camera';import { Geolocation } from '@capacitor/geolocation';import { Storage } from '@capacitor/preferences';
// Cameraconst photo = await Camera.getPhoto({ quality: 90, resultType: CameraResultType.Uri});
// Geolocationconst position = await Geolocation.getCurrentPosition();
// Storageawait Storage.set({ key: 'name', value: 'John' });With Capgo Plugins
Section titled “With Capgo Plugins”Capgo plugins work perfectly with Capacitor+:
import { CapacitorUpdater } from '@capgo/capacitor-updater';import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';import { CapacitorFlash } from '@capgo/capacitor-flash';
// Live updatesawait CapacitorUpdater.notifyAppReady();
// Screen orientationawait ScreenOrientation.lock({ orientation: 'portrait' });
// Flashlightawait CapacitorFlash.toggle();How the Sync Works
Synchronisierungsprozess┌─────────────────────┐ ┌──────────────────┐ ┌──────────────────┐ ┌─────────────────┐│ ionic-team/ │ │ CI/CD │ │ Claude Code │ │ npm publish ││ capacitor │────▶│ Pipeline │────▶│ Security Review │────▶│ @capacitor-plus││ (upstream) │ │ (daily sync) │ │ (AI analysis) │ │ packages │└─────────────────────┘ └──────────────────┘ └──────────────────┘ └─────────────────┘- Tagliche Synchronisierung: GitHub Aktionen holen die neuesten Änderungen von
ionic-team/capacitor - Pull-Request-Erstellung: Änderungen werden als Pull-Requests an das
plusZweig - CI-Validierung: Vollständige Test-Suite läuft (Linter, Einheitstests, iOS-Build, Android-Build)
- Sicherheitsüberprüfung: KI-gestützte Analyse überprüft nach Sicherheitslücken und Bruchstellen
- Automatische Merge: Nur wenn CI erfolgreich ist UND Sicherheitsüberprüfung genehmigt hat
- Automatische Veröffentlichung: Neuere Version veröffentlicht unter npm
@capacitor-plus/*
Sicherheitsüberprüfungsdetails
Abschnitt mit dem Titel “Sicherheitsüberprüfungsdetails”Jeder Upstream-Sync wird auf folgende Dinge analysiert:
| Überprüfung | Was es Fängt |
|---|---|
| Sicherheit | Befehlsinjektion, XSS, Pfadüberprüfung, festgelegte Geheimnisse |
| Änderungen mit Auswirkungen auf die Kompatibilität | Entfernte/umbenannte APIs, geänderte Signatur, Konfigurationsänderungen |
| Stabilität | Null-Verweise, unbehandelte Exceptions, Rassenbedingungen, Speicherverluste |
| Daten-Sicherheit | Datenverlustszenarien, Verletzungen der Privatsphäre, unsichere Speicherung |
| Code Integrität | Verschlüsselte code, verdächtige Netzwerkaufrufe, Hintertüren |
Pull-Request einreichen
Pull-Request einreichenEin Pull-Request steckt im offiziellen Capacitor-Repo fest? Lassen Sie ihn in Capacitor+ einlaufen:
-
Ein Issue öffnen im Capacitor+-Repo mit Verweis auf Ihren upstream-PR
-
Oder senden Sie direkt als PR zum
plusBranch -
Das Team wird den Pull-Request überprüfen, CI ausführen und ihn einfügen, wenn er erfolgreich ist
Somit können Sie und andere sofort von Ihrem Werk profitieren, ohne auf das Release-Zyklus des upstream-Repo warten zu müssen.
Ist dies für die Produktion bereit?
Abschnitt mit dem Titel “Ist dies für die Produktion bereit?”Ja. Capacitor+ wird in Produktionsanwendungen verwendet. Jedes Release besteht denselben Test-Suite wie die offizielle Capacitor, plus zusätzliche Sicherheitsanalyse.
Arbeiten meine offiziellen Plugins noch?
Abschnitt mit dem Titel “Arbeiten meine offiziellen Plugins noch?”Ja. Alle @capacitor/* Plugins funktionieren mit Capacitor+ ohne weitere Konfiguration.
Was passiert, wenn ein Upstream ein breakender Change veröffentlicht?
Abschnitt mit dem Titel “Was passiert, wenn ein Upstream ein breakender Change veröffentlicht?”Die AI-Sicherheitsprüfung meldet breakende Änderungen für eine manuelle Überprüfung. Sie sehen die Änderungen dokumentiert, bevor sie eingefügt werden.
Wie melde ich Fehler?
Abschnitt mit dem Titel “Wie melde ich Fehler?”Dateien im Capacitor + GitHub-Repositorymelden. Für Probleme, die auch das offizielle Capacitor betreffen, helfen wir bei der Koordination von Änderungen im Hauptcode.
Kann ich beitragen?
Sektion mit dem Titel "Kann ich beitragen?"Ja, das ist möglich! Pull Requests sind willkommen. Sie können Fixes direkt einreichen oder bitten, dass bestimmte Pull Requests aus dem Hauptcode integriert werden.
Fortsetzen Sie mit Getting Started
Sektion mit dem Titel "Fortsetzen Sie mit Getting Started"Wenn Sie Getting Started zur Planung von native Plugin-Arbeiten verwenden, verbinden Sie es mit Verwendung von Capacitor+ (@capacitor-plus)-Paketen für die native Fähigkeit in Verwendung von Capacitor+ (@capacitor-plus) Paketen Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis Capacitor Plugins von Capgo für die Implementierungsdetail in Capacitor Plugins von Capgo Hinzufügen oder Aktualisieren von Plugins für die Implementierungsdetail in Hinzufügen oder Aktualisieren von Plugins, und Ionic Enterprise Plugin Alternativen für den Produktworkflow in Ionic Enterprise Plugin Alternativen.