Konfigurationsoptionen
Eine Setup-Vorlage mit den Installationsanweisungen und der vollständigen Markdown-Dokumentation für diesen Plugin kopieren.
Vollständige Referenz für jede Cloud Build-Konfigurationsoption. Verwenden Sie diese Seite, um die CLI-Flag, Umgebungsvariable oder Zertifikatschlüssel für jede Konfigurationseinstellung zu finden.
Konfigurationsvorrang
Jede Konfigurationsoption kann auf mehrere Weise gesetzt werden. Wenn dieselbe Option auf mehreren Stellen gesetzt wird, gewinnen höherprioritäre Quellen:Konfigurationsvorrang: __CAPGO_KEEP_0__-Flags überschreiben Umgebungsvariablen, die wiederum lokale Zertifikate überschreiben, die wiederum globale Zertifikate überschreiben
flowchart LR
A["🔧 CLI Flag"] -->|overrides| B["🌍 Environment Variable"]
B -->|overrides| C["📁 Local Credentials"]
C -->|overrides| D["🏠 Global Credentials"]
style A fill:#6366f1,color:#fff,stroke:#4f46e5
style B fill:#8b5cf6,color:#fff,stroke:#7c3aed
style C fill:#a78bfa,color:#fff,stroke:#8b5cf6
style D fill:#c4b5fd,color:#1e1b4b,stroke:#a78bfa
Wenn Ihre gespeicherten Zertifikate aber Sie übergeben SKIP_BUILD_NUMBER_BUMP=true auf der __CAPGO_KEEP_0__, gewinnt das __CAPGO_KEEP_1__-Flag und die Build-Zahlen werden automatisch inkrementiert. --no-skip-build-number-bump on the CLI, the CLI flag wins and build numbers will be auto-incremented.
IOS-Optionen
Abschnitt mit dem Titel “IOS-Optionen”Code Signierung
Abschnitt mit dem Titel “Code Signierung”| CLI Flag | Umgebungsvariable | Zugriffschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--build-certificate-base64 <cert> | BUILD_CERTIFICATE_BASE64 | BUILD_CERTIFICATE_BASE64 | — | Base64-codiert .p12 Verteilungszertifikat |
--ios-provisioning-profile <map> | CAPGO_IOS_PROVISIONING_MAP | CAPGO_IOS_PROVISIONING_MAP | — | Zertifikatsprofil als path oder bundleId=path Zuweisung. Wiederholbar für Mehrziel-Anwendungen (Anwendung + Erweiterungen); der Profilname wird automatisch extrahiert. |
--p12-password <password> | P12_PASSWORD | P12_PASSWORD | — | Zugangsdaten für das .p12 (Übergehen, wenn das Zertifikat kein Passwort hat) |
Authentifizierung für App Store Connect
Sektion mit dem Titel “Authentifizierung für App Store Connect”| CLI Flagge | Umgebungsvariable | Benutzerkennwort | Standard | Beschreibung |
|---|---|---|---|---|
--apple-key-id <id> | APPLE_KEY_ID | APPLE_KEY_ID | — | App Store Connect API Schlüssel-ID |
--apple-issuer-id <id> | APPLE_ISSUER_ID | APPLE_ISSUER_ID | — | App Store Connect Aussteller-ID (UUID) |
--apple-key-content <content> | APPLE_KEY_CONTENT | APPLE_KEY_CONTENT | — | Base64-codierte App Store Connect API-Schlüssel (.p8 Datei) |
--app-store-connect-team-id <id> | APP_STORE_CONNECT_TEAM_ID | APP_STORE_CONNECT_TEAM_ID | — | App Store Connect Team-ID |
App-basierte Passwortauthentifizierung (nicht empfohlen)
Abschnitt mit dem Titel “App-basierte Passwortauthentifizierung (nicht empfohlen)”| CLI Flag | Umgebungsvariable | Zugriffsschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--apple-id <email> | FASTLANE_USER | FASTLANE_USER | — | E-Mail-Adresse des Apple-Kontos, das das App gehört |
--apple-app-specific-password <password> | FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD | FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD | — | App-spezifischer Passwort (xxxx-xxxx-xxxx-xxxx) generiert auf appleid.apple.com |
--apple-app-id <id> | APPLE_APP_ID | APPLE_APP_ID | — | Numerischer App Store Connect-App-ID (z.B. 1234567890) |
iOS-Build-Einstellungen
Abschnitt mit dem Titel „iOS-Build-Einstellungen“| CLI Flag | Umgebungsvariable | Zugriffschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--ios-scheme <scheme> | CAPGO_IOS_SCHEME | CAPGO_IOS_SCHEME | App | Xcode-Scheme zum Bauen |
--ios-target <target> | CAPGO_IOS_TARGET | CAPGO_IOS_TARGET | App | Xcode-Ziel zum Lesen von Build-Einstellungen |
--ios-distribution <mode> | CAPGO_IOS_DISTRIBUTION | CAPGO_IOS_DISTRIBUTION | app_store | Verteilungsmodus: app_store oder ad_hoc |
Android-Optionen
Abschnitt mit dem Titel “Android-Optionen”Keystore-Zertifizierung
Abschnitt mit dem Titel “Keystore-Zertifizierung”| CLI Flag | Umgebungsvariable | Kreditkarten-Schlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--android-keystore-file <keystore> | ANDROID_KEYSTORE_FILE | ANDROID_KEYSTORE_FILE | — | Bas64-codierter Keystore-Datei (.keystore oder .jks) |
--keystore-key-alias <alias> | KEYSTORE_KEY_ALIAS | KEYSTORE_KEY_ALIAS | key0 | Schlüsseltresorschlüsselalias |
--keystore-key-password <password> | KEYSTORE_KEY_PASSWORD | KEYSTORE_KEY_PASSWORD | — | Schlüsseltresorschlüsselpasswort (falls nicht gesetzt, fällt es auf das Speicherpasswort zurück) |
--keystore-store-password <password> | KEYSTORE_STORE_PASSWORD | KEYSTORE_STORE_PASSWORD | — | Schlüsseltresorspeicherpasswort |
Google Play-Konfiguration
Sektion mit dem Titel “Google Play-Konfiguration”| CLI-Flag | Umgebungsvariable | Benutzerkennungsschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--play-config-json <json> | PLAY_CONFIG_JSON | PLAY_CONFIG_JSON | — | Bas64-kodierte Google Play-Dienstkontokennwort-JSON-Schlüssel |
| (umgebungsbezogen) | PLAY_STORE_TRACK | — | internal | Google Play Release-Spur (internal, alpha, beta, production) |
| (umgebungsspezifisch) | PLAY_STORE_RELEASE_STATUS | — | draft | Freigabe-Status auf der gewählten Spur (draft, completed, inProgress, halted) |
Android-Build-Einstellungen
Abschnitt mit dem Titel “Android Build-Einstellungen”| CLI-Flag | Standard | Beschreibung |
|---|---|---|
--android-flavor <flavor> | — | Produktflavor zum Bauen (z.B. production). Pflichtfeld Wenn Ihr Projekt mehrere Flavours definiert. |
--in-app-update-priority <0–5> | — | Google Play in-app-Update-Priorität für diese Freigabe (höher = dringender). |
--no-playstore-upload | — | Bauen und signieren, aber die Play Store-Upload-Funktion auslassen (erfordert --output-upload). |
Baukontrollmöglichkeiten
Abschnitt mit dem Titel “Baukontrollmöglichkeiten”Diese Optionen funktionieren für beide iOS- und Android-Builds.
| CLI-Flag | Standard | Beschreibung |
|---|---|---|
--platform <platform> | — | Erforderlich. ios oder android |
--build-mode <mode> | release | debug oder release |
--path <path> | . | Projektverzeichnis |
--verbose | false | Verbose Build-Loggen aktivieren |
--ai-analytics | false | Bei Build-Fehlern werden die Protokolle an Capgo AI zur Diagnose weitergeleitet — siehe AI-Build-Diagnose |
Build-Nummer-Kontrolle
Abschnitt mit dem Titel „Build-Nummer-Kontrolle“| CLI-Flag | Umgebungsvariable | Zugriffschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--skip-build-number-bump | SKIP_BUILD_NUMBER_BUMP | SKIP_BUILD_NUMBER_BUMP | false | Automatische Build-Nummer-/Version code-Zählung überspringen |
--no-skip-build-number-bump | — | — | — | Explicitly re-enable auto-increment (overrides gespeicherte Anmeldeinformationen) |
Standardmäßig erhöht Capgo Cloud Build automatisch die Buildnummern:
- iOS: Lädt die neueste Buildnummer aus App Store Connect, erhöht sie um 1
- Android: Lädt den maximalen Wert von Google Play, erhöht ihn um 1
versionCodeWenn
die Build verwendet, was bereits in Ihren Projektdateien (Xcode-Projekt oder --skip-build-number-bump Ausgabeanhänge build.gradle).
Abschnitt mit dem Titel “Ausgabeanhänge”
__CAPGO_KEEP_0__ Flag| CLI Flag | Umgebungsvariable | Benutzerschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | BUILD_OUTPUT_UPLOAD_ENABLED | false | Upload-Build-Ergebnisse (IPA/APK/AAB) auf Capgo-Speicher. Wenn über Umgebungsvariable gesetzt, verwenden BUILD_OUTPUT_UPLOAD_ENABLED=true. |
--no-output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | — | — | Ausgabe-Upload deaktivieren. Wenn über Umgebungsvariable gesetzt, verwenden BUILD_OUTPUT_UPLOAD_ENABLED=false. |
--output-retention <duration> | BUILD_OUTPUT_RETENTION_SECONDS | BUILD_OUTPUT_RETENTION_SECONDS | 1h | wie lange Download-Links aktiv bleiben |
--output-record <path> | — | — | — | Nach erfolgreichem Build, eine JSON-Datei (Job-ID, Status, Download-URL, QR-Code code) schreiben <path> — mit lesen build last-output. |
Retention-Format: Menschliche Lesbarkeit-Dauern wie 1h, 6h, 2d, 7d. Mindestens 1 Stunde, höchstens 7 Tage. Wenn über Umgebungsvariable gesetzt, verwenden Sekunden (z.B. 3600 Eine Stunde).
Authentifizierung
Abschnitt mit dem Titel „Authentifizierung“| CLI Flag | Umgebungsvariable | Standard | Beschreibung |
|---|---|---|---|
-a, --apikey <key> | CAPGO_TOKEN | — | Capgo API Schlüssel für die Authentifizierung |
--supa-host <host> | — | — | Eigene Supabase-Host (nur Selbsthosting) |
--supa-anon <key> | — | — | Eigene Supabase-Anon-Key (nur Selbsthosting) |
Umgebungsvariable-Quick-Referenz
Abschnitt mit dem Titel „Umgebungsvariable-Quick-Referenz“Für Ihre CI/CD-Pipeline kopier- und einfügenbereit. Alle Variablen sind optional — setzen Sie nur das, was Sie benötigen.
# Code signing (required for iOS builds)BUILD_CERTIFICATE_BASE64="<base64-encoded .p12>"CAPGO_IOS_PROVISIONING_MAP="<provisioning map generated by the CLI>"P12_PASSWORD="<certificate password>"
# App Store Connect (required for store submission)APPLE_KEY_ID="ABC1234567"APPLE_ISSUER_ID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"APPLE_KEY_CONTENT="<base64-encoded .p8 key>"APP_STORE_CONNECT_TEAM_ID="TEAM123456"
# Alternative to the App Store Connect API key above: Apple ID + app-specific# password (e.g. when migrating from Ionic Appflow). All three are required.# FASTLANE_USER="apple-id@example.com"# FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD="xxxx-xxxx-xxxx-xxxx"# APPLE_APP_ID="1234567890"
# Optional iOS settingsCAPGO_IOS_SCHEME="App"CAPGO_IOS_TARGET="App"# Keystore signing (required for Android builds)ANDROID_KEYSTORE_FILE="<base64-encoded .keystore>"KEYSTORE_KEY_ALIAS="my-key-alias"KEYSTORE_KEY_PASSWORD="<key password>"KEYSTORE_STORE_PASSWORD="<store password>"
# Google Play (required for store submission)PLAY_CONFIG_JSON="<base64-encoded service account JSON>"
# Optional Android settingsPLAY_STORE_TRACK="internal"PLAY_STORE_RELEASE_STATUS="draft"Build Control
Abschnitt mit dem Titel „Build Control“# Build behaviorSKIP_BUILD_NUMBER_BUMP="true" # Skip auto-incrementBUILD_OUTPUT_UPLOAD_ENABLED="true" # Upload IPA/APK/AABBUILD_OUTPUT_RETENTION_SECONDS="3600" # 1 hour download link
# AuthenticationCAPGO_TOKEN="your-api-key"Zugriffsdaten Speicherung
Abschnitt mit dem Titel „Zugriffsdaten Speicherung“Sichere Zugriffsdaten lokal ab
Abschnitt mit dem Titel „Sichere Zugriffsdaten lokal ab“Stattdessen Flags oder Umgebungsvariablen jederzeit übergeben, Zugriffsdaten einmal speichern:
# Save iOS credentialsbunx @capgo/cli@latest build credentials save \ --platform ios \ --certificate ./dist_cert.p12 \ --ios-provisioning-profile ./profile.mobileprovision \ --p12-password "cert-password" \ --apple-key ./AuthKey.p8 \ --apple-key-id ABC1234567 \ --apple-issuer-id xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ --apple-team-id TEAM123456
# Save Android credentialsbunx @capgo/cli@latest build credentials save \ --platform android \ --keystore ./release.keystore \ --keystore-alias my-key \ --keystore-key-password "key-pass" \ --keystore-store-password "store-pass" \ --play-config ./play-service-account.jsonSpeicherort
Abschnitt mit dem Titel „Speicherort“| Flagge | Standort | Verwendungsfall |
|---|---|---|
| (Standard) | ~/.capgo-credentials/credentials.json | Global — gemeinsam für alle Projekte auf Ihrem Computer |
--local | .capgo-credentials.json im Projektroot | Projektbezogen — überschreibt das globale, wenn beide existieren |
Die Anmeldeinformationen werden durch Anwendungs-ID (z.B. com.example.myapp), so kann ein einzelner Anmeldeinformationsdatei Einstellungen für mehrere Apps ohne Konflikte speichern. Jede App-Anmeldeinformationen werden weiterhin durch Plattform (ios / android).
Gespeicherte Anmeldeinformationen verwalten
Abschnitt mit dem Titel „Gespeicherte Anmeldeinformationen verwalten“# List saved credentialsbunx @capgo/cli@latest build credentials list
# Update a specific option without re-entering everythingbunx @capgo/cli@latest build credentials update --skip-build-number-bump
# Clear saved credentialsbunx @capgo/cli@latest build credentials clear --platform iosBeispiele
Abschnitt mit dem Titel „Beispiele“GitHub Aktionen
Abschnitt mit dem Titel „GitHub Aktionen“name: Build and Submiton: push: branches: [main]
jobs: build-ios: runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 - uses: oven-sh/setup-bun@v2 - run: bun install - run: bunx cap sync ios - run: bunx @capgo/cli@latest build request --platform ios env: CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }} BUILD_CERTIFICATE_BASE64: ${{ secrets.IOS_CERTIFICATE }} CAPGO_IOS_PROVISIONING_MAP: ${{ secrets.CAPGO_IOS_PROVISIONING_MAP }} P12_PASSWORD: ${{ secrets.P12_PASSWORD }} APPLE_KEY_ID: ${{ secrets.APPLE_KEY_ID }} APPLE_ISSUER_ID: ${{ secrets.APPLE_ISSUER_ID }} APPLE_KEY_CONTENT: ${{ secrets.APPLE_KEY_CONTENT }} APP_STORE_CONNECT_TEAM_ID: ${{ secrets.APP_STORE_CONNECT_TEAM_ID }}
build-android: runs-on: ubuntu-latest steps: - uses: actions/checkout@v6 - uses: oven-sh/setup-bun@v2 - run: bun install - run: bunx cap sync android - run: bunx @capgo/cli@latest build request --platform android env: CAPGO_TOKEN: ${{ secrets.CAPGO_TOKEN }} ANDROID_KEYSTORE_FILE: ${{ secrets.ANDROID_KEYSTORE }} KEYSTORE_KEY_ALIAS: ${{ secrets.KEYSTORE_ALIAS }} KEYSTORE_KEY_PASSWORD: ${{ secrets.KEYSTORE_KEY_PASSWORD }} KEYSTORE_STORE_PASSWORD: ${{ secrets.KEYSTORE_STORE_PASSWORD }} PLAY_CONFIG_JSON: ${{ secrets.PLAY_CONFIG_JSON }}Mit CLI-Flags direkt verwenden
Abschnitt mit dem Titel „CLI Flags direkt verwenden“# Build iOS with all options inlinebunx @capgo/cli@latest build request \ --platform ios \ --build-mode release \ --skip-build-number-bump \ --output-retention 6h \ --apikey YOUR_API_KEY
# Build Android, skip version bump, no output uploadbunx @capgo/cli@latest build request \ --platform android \ --skip-build-number-bump \ --no-output-upload \ --apikey YOUR_API_KEYMischkonfiguration
Abschnitt mit dem Titel „Mischkonfiguration“Gespeicherte Anmeldeinformationen kombinieren mit CLI-Überschreibungen:
# Save base credentials oncebunx @capgo/cli@latest build credentials save --platform ios \ --certificate ./cert.p12 \ --ios-provisioning-profile ./profile.mobileprovision \ --output-upload
# Override specific options per-buildbunx @capgo/cli@latest build request --platform ios \ --skip-build-number-bump \ --output-retention 2dDie gespeicherten Anmeldeinformationen liefern Signaturdetails, während CLI-Flags die Ausführungsverhalten für diese spezifische Ausführung überschreiben.