Konfigurationsoptionen
Einen Einrichtungsprompt 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 Flagge, Umgebungsvariable oder Schlüssel für jede Konfigurationseinstellung zu finden.
Konfigurationsvorrang
Abschnitt mit dem Titel “Konfigurationsvorrang”Jede Buildoption kann auf mehrere Weise gesetzt werden. Wenn dieselbe Option an mehreren Stellen gesetzt wird, gewinnen höherprioritäre Quellen:
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
Beispiel: Wenn Ihre gespeicherten Anmeldeinformationen SKIP_BUILD_NUMBER_BUMP=true aber Sie übergeben --no-skip-build-number-bump auf der CLI, gewinnt die CLI-Flag und die Buildnummern werden automatisch inkrementiert.
iOS-Optionen
Abschnitt mit dem Titel “iOS-Optionen”Code Signierung
Abschnitt mit dem Titel “Code Signierung”| CLI Flagge | 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 | — | Provisionierungsprofil als path oder bundleId=path mapping. Wiederholbar für Mehrfachziel-Anwendungen (Anwendung + Erweiterungen); der Profilname wird automatisch extrahiert. |
--p12-password <password> | P12_PASSWORD | P12_PASSWORD | — | Zugangsdaten für das .p12 Zertifikat (Übergehen, wenn das Zertifikat kein Passwort hat) |
App Store Connect Authentifizierung
Abschnitt mit dem Titel „App Store Connect Authentifizierung“| CLI Flagge | Umgebungsvariable | Zugangsdaten-Schlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--apple-key-id <id> | APPLE_KEY_ID | APPLE_KEY_ID | — | App Store Connect API-Zertifikatschlüssel |
--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-codiertes 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-spezifische Passwort-Authentifizierung (nicht empfohlen)
Abschnitt mit dem Titel “App-spezifische Passwort-Authentifizierung (nicht empfohlen)”| CLI-Flag | Umgebungsvariable | Zugriffschlü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) auf appleid.apple.com generiert numerische App-Store-Connect-App-ID (z.B. |
--apple-app-id <id> | APPLE_APP_ID | APPLE_APP_ID | — | Numerische 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 für die Lesung 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 | Zugriffschlü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 | Keystore-Schlüsselalias |
--keystore-key-password <password> | KEYSTORE_KEY_PASSWORD | KEYSTORE_KEY_PASSWORD | — | Keystore-Schlüsselpasswort (fällt zurück auf Speicherpasswort, wenn nicht gesetzt) |
--keystore-store-password <password> | KEYSTORE_STORE_PASSWORD | KEYSTORE_STORE_PASSWORD | — | Keystore-Speicher-Passwort |
Google Play-Konfiguration
Abschnitt mit dem Titel “Google Play-Konfiguration”| CLI-Flag | Umgebungsvariable | Benutzerschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--play-config-json <json> | PLAY_CONFIG_JSON | PLAY_CONFIG_JSON | — | Base64-codiertes Google Play-Dienstkontokennwort |
--android-track <track> | PLAY_STORE_TRACK | PLAY_STORE_TRACK | internal (oder production mit --submit-to-store-review) | Google Play-Veröffentlichungsstrecke (internal, alpha, beta, production. Von der CI-Umgebung / CLI in den Build-Runner weitergeleitet. |
--android-release-status <status> | PLAY_STORE_RELEASE_STATUS | PLAY_STORE_RELEASE_STATUS | draft (oder completed mit --submit-to-store-review) | Release-Status auf der gewählten Spur (draft, completed, inProgress, halted). Explizite Werte überschreiben die --submit-to-store-review Standard. |
Android-Build-Einstellungen
Sektion mit dem Titel „Android Build Einstellungen“| CLI-Flag | Standard | Beschreibung |
|---|---|---|
--android-flavor <flavor> | — | Produktflavor zum Bauen (z.B. production). Erforderlich wenn Ihr Projekt mehrere Geschmacksrichtungen definiert. |
--android-track <track> | internal | Google Play-Track für diese Hochladung. Mit --submit-to-store-review und keinem Track gesetzt, Capgo setzt sich auf production. |
--android-release-status <status> | draft | Google Play-Veröffentlichungsstatus. Mit --submit-to-store-review und keinem Status gesetzt, Capgo setzt sich auf completed. |
--in-app-update-priority <0–5> | — | Google Play in-app-Update-Priorität für diese Version (höher = dringender). |
--no-playstore-upload | — | Bauen und signieren, aber die Play Store-Hochladung überspringen (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 | Erweiterte Build-Protokollierung aktivieren |
--ai-analytics | false | Bei Build-Fehlern werden die Protokolle an die Capgo-AI zur Diagnose gesendet – siehe AI-Build-Diagnose |
Build-Nummer-Kontrolle
Abschnitt mit dem Titel „Build Number Control“| 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 erhöhen überspringen |
--no-skip-build-number-bump | — | — | — | Automatische Erhöhung explizit wieder aktivieren (überschreibt gespeicherte Zugriffsdaten) |
By default, Capgo Cloud Build erhöht automatisch die Buildnummern:
- iOS: Lädt die neueste Build-Nummer aus App Store Connect, erhöht sie um 1
- Android: Holt max
versionCodeaus Google Play, erhöht sich um 1
Wenn --skip-build-number-bump wird verwendet, wenn die Build die Version verwendet, die bereits in Ihren Projektdateien (Xcode-Projekt oder build.gradle).
Ausgabehochladen
Abschnitt mit dem Titel “Ausgabehochladen”| CLI Flag | Umgebungsvariable | Zugriffschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | BUILD_OUTPUT_UPLOAD_ENABLED | false | Hochladen von Buildausgaben (IPA/APK/AAB) in Capgo-Speicher. Wenn über Umgebungsvariable gesetzt, verwenden Sie BUILD_OUTPUT_UPLOAD_ENABLED=true. |
--no-output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | — | — | Disable output upload. When set via env var, use BUILD_OUTPUT_UPLOAD_ENABLED=false. |
--output-retention <duration> | BUILD_OUTPUT_RETENTION_SECONDS | BUILD_OUTPUT_RETENTION_SECONDS | 1h | Wie lange bleiben Downloadlinks aktiv? |
--output-record <path> | — | — | — | Nach erfolgreichem Build, schreibe eine JSON-Datei (Job-ID, Status, Download-URL, QR code) <path> Wenn Sie es mit build last-output. |
Format der Aufbewahrung: Verwenden Sie menschenlesbare Dauerangaben wie 1h, 6h, 2d, 7dMindestzeit ist 1 Stunde, maximal 7 Tage. Bei Einstellung über Umgebungsvariable wird in Sekunden verwendet (z.B.). 3600 Build-Cache
Capgo speichert kompilierte native Artefakte (CocoaPods, Gradle und verwandte Buildausgaben) pro App schnellere Wiederholungsbauten starten. Der Build-Cache ist standardmäßig aktiviert. für jede App.
| CLI Flag | API Feld | Standard | Beschreibung |
|---|---|---|---|
--no-cache | cache_enabled: false | Cache aktivieren | Cache für diese Baustelle deaktivieren: Restore überspringen und speichere keine neue Eintragung |
--cache-key <value> | cache_key | (ignoriere) | Teilen Sie den Cache (z. B. prod, staging. Omit für eine gemeinsame Cacheinstanz pro App |
CLI-Äquivalente: build request akzeptiert --no-cache und --cache-key.
CLI-Beispiele:
# Default: restore/save the shared per-app cachebunx @capgo/cli@latest build request com.example.app --platform android
# Separate caches per environmentbunx @capgo/cli@latest build request com.example.app --platform android \ --cache-key=prod
bunx @capgo/cli@latest build request com.example.app --platform android \ --cache-key=staging \ --android-flavor staging
# One-off clean build (no restore, no save)bunx @capgo/cli@latest build request com.example.app --platform ios --no-cacheAPI / Webhook-Payload (wenn Ihre Integration Capgo direkt aufbaut):
{ "platform": "android", "cache_key": "prod"}Übergehen cache_key für den gemeinsamen allgemeinen Cache. Setzen Sie cache_key auf Umgebungen partitionieren. Setzen Sie "cache_enabled": false to disable cache for a single request (same as --no-cache).
Wenn ein Build erfolgreich aussieht, aber das Artefakt falsch ist – oder ein Android AAB fehlt, nachdem Sie von RC auf Produktion umgeschaltet haben – versuchen Sie einen dedizierten Cache-Schlüssel oder eine einmalige --no-cache Aufbau. Siehe Troubleshooting: falsche Cache-Restore.
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> | — | — | Benutzerdefinierter Supabase-Host (nur Selbsthosting) |
--supa-anon <key> | — | — | Benutzerdefinierter Supabase-Anon-Key (nur Selbsthosting) |
Umgebungsvariable-Quick-Reference
Abschnitt mit dem Titel “Umgebungsvariable-Quick-Reference”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-Kontrolle
Abschnitt mit dem Titel “Build-Kontrolle”# 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 speichern
Abschnitt mit dem Titel “Zugriffsdaten speichern”Sicherheitsdaten lokal speichern
Abschnitt mit dem Titel “Sicherheitsdaten lokal speichern”Stattdessen Flags oder Umgebungsvariablen jederzeit übergeben, speichern Sie die Zugriffsdaten einmal:
# 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.jsonSpeicherorte
Abschnitt mit dem Titel “Speicherorte”| Flagge | Speicherort | Verwendungszweck |
|---|---|---|
| (default) | ~/.capgo-credentials/credentials.json | Global — gemeinsam für alle Projekte auf Ihrem Computer |
--local | .capgo-credentials.json in Projektroot | Projektübergreif — überschreibt Global, wenn beide existieren |
Die Anmeldeinformationen werden durch Anwendungs-ID (z.B. com.example.myapp), so kann ein einzelner Anmeldeinformationen-Datei Einstellungen für mehrere Anwendungen ohne Konflikte speichern. Jede Anwendung wird weiterhin durch die Plattform (ios / android).
Kontoangaben verwalten
Abschnitt mit dem Titel “Kontoangaben 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 }}Mithilfe von CLI Flaggen direkt verwenden
Benennung "Direkte Verwendung von CLI-Flaggen"# 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“Kombinieren Sie gespeicherte Anmelddaten mit CLI-Überwriten:
# 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 Signierungsdaten, während CLI-Flaggen die Build-Verhaltensweise für diese spezifische Ausführung überschreiben.