Konfigurationsoptionen
Einen Einrichtungsvorschlag mit den Installationsanweisungen und der vollständigen Markdown-Dokumentation für diesen Plugin kopieren
Eine umfassende Referenz für jede Cloud Build-Konfigurationsoption. Verwenden Sie diese Seite, um die CLI-Flag, Umgebungsvariable oder Anmeldeinformationsschlüssel für jede Konfigurationseinstellung zu finden.
Konfigurationsvorrang
Abschnitt mit dem Titel “Konfigurationsvorrang”Jede Buildoption kann auf mehrere Weise gesetzt werden. Wenn dieselbe Option auf mehrere Weise 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 On dem CLI, gewinnt die CLI-Flag und die Build-Zahlen werden automatisch inkrementiert.
iOS-Optionen
Abschnitt mit dem Titel „iOS-Optionen“Code-Signierung
Abschnitt mit dem Titel „Code-Signierung“| CLI-Flag | Umgebungsvariable | Anmeldeinformationsschlüsel | 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 Entsprechend |
--p12-password <password> | P12_PASSWORD | P12_PASSWORD | — | Zuordnung. Wiederholbar für Mehrzielanwendungen (Anwendung + Erweiterungen); der Profilname wird automatisch extrahiert. .p12 Kennwort für das |
Zertifikat (Übergehen, wenn das Zertifikat kein Kennwort hat)
App Store Connect-Authentifizierung| CLI Flag | Umgebungsvariable | Zugriffschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--apple-key-id <id> | APPLE_KEY_ID | APPLE_KEY_ID | — | App Store Connect API-Sicherheitszertifikatschlüssel |
--apple-issuer-id <id> | APPLE_ISSUER_ID | APPLE_ISSUER_ID | — | App Store Connect-Emittenten-ID (UUID) |
--apple-key-content <content> | APPLE_KEY_CONTENT | APPLE_KEY_CONTENT | — | Base64-codiertes App Store Connect API-Sicherheitszertifikat (.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 Kennwortauthentifizierung (nicht empfohlen)
Sektion mit dem Titel “App-spezifische Kennwortauthentifizierung (nicht empfohlen)”| CLI-Flag | Umgebungsvariable | Zugriffschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--apple-id <email> | FASTLANE_USER | FASTLANE_USER | — | Apple-ID-E-Mail-Adresse des Kontos, das das App gehört |
--apple-app-specific-password <password> | FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD | FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD | — | App-spezifisches Kennwort (xxxx-xxxx-xxxx-xxxx) generiert am appleid.apple.com |
--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 |
Entscheiden Sie sich für eine der folgenden Optionen, um Ihre Anwendung zu erstellen: Sie können auch unsere Appflow- oder Capawesome-Alternative verwenden, um Ihre Anwendung zu erstellen. Wir bieten auch unsere Consulting-Dienste an, um Ihnen bei der Erstellung Ihrer Anwendung zu helfen.
Android-OptionenAbschnitt mit dem Titel “Android-Optionen”
Keystore-Zertifikatsignierung| CLI Flag | __CAPGO_KEEP_0__-Flag | Umgebungsvariable | Standard | Beschreibung |
|---|---|---|---|---|
--android-keystore-file <keystore> | ANDROID_KEYSTORE_FILE | ANDROID_KEYSTORE_FILE | — | Base64-codierter Keystore-Datei (.keystore oder .jks) |
--keystore-key-alias <alias> | KEYSTORE_KEY_ALIAS | KEYSTORE_KEY_ALIAS | key0 | oder |
--keystore-key-password <password> | KEYSTORE_KEY_PASSWORD | KEYSTORE_KEY_PASSWORD | — | Keystore-Schlüssel-Bezeichner |
--keystore-store-password <password> | KEYSTORE_STORE_PASSWORD | KEYSTORE_STORE_PASSWORD | — | Keystore-Schlüssel-Passwort (fällt auf Speicher-Passwort zurück, wenn nicht gesetzt) |
Keystore-Speicher-Passwort
Google Play-Konfiguration| CLI Flag | __CAPGO_KEEP_0__ Flag | Umgebungsvariable | Standard | Beschreibung |
|---|---|---|---|---|
--play-config-json <json> | PLAY_CONFIG_JSON | PLAY_CONFIG_JSON | — | Base64-codiertes JSON-Schlüsseldaten des Google Play-Dienstes |
--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). Forwarded from CI env / CLI into the build runner. |
--android-release-status <status> | PLAY_STORE_RELEASE_STATUS | PLAY_STORE_RELEASE_STATUS | draft Vorwärts von CI-Umgebung / __CAPGO_KEEP_0__ in den Build-Runner. completed oder --submit-to-store-review) | mitdraft, completed, inProgress, haltedFreigabestatus auf der gewählten Strecke ( --submit-to-store-review ) |
Einstellungen für Android-Builds
Abschnitt mit dem Titel “Einstellungen für Android-Builds”| CLI-Flag | Standard | Beschreibung |
|---|---|---|
--android-flavor <flavor> | — | Produktflavor zum Bauen (z.B. production). erforderlich falls Ihr Projekt mehrere Flavours definiert. |
--android-track <track> | internal | Google Play-Track für diese Uploads. 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-Uploads ü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> | . | Projektordner |
--verbose | false | Erweiterte Build-Protokollierung aktivieren |
--ai-analytics | false | Bei Build-Fehlern werden Protokolle an Capgo AI zur Diagnose senden — siehe AI-Build-Diagnose |
Build-Nummer-Kontrolle
Abschnitt mit dem Titel ‘Build-Nummer-Kontrolle’| CLI-Flagge | Umgebungsvariable | Zugriffschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--skip-build-number-bump | SKIP_BUILD_NUMBER_BUMP | SKIP_BUILD_NUMBER_BUMP | false | Automatisches Build-Nummer / Version code-Zählung überspringen |
--no-skip-build-number-bump | — | — | — | Automatische Zählung explizit wieder aktivieren (überschreibt gespeicherte Anmeldeinformationen) |
Standardmäßig erhöht Capgo Cloud Build die Build-Nummern automatisch:
- iOS: Lädt die neueste Build-Nummer von App Store Connect, erhöht sie um 1
- Android: Lädt die Maximal-
versionCodeNummer von Google Play, erhöht sie um 1
Wenn --skip-build-number-bump wird gesetzt, verwendet das Build-System die Version, die bereits in Ihren Projektdateien (Xcode-Projekt oder build.gradle).
Abschnitt mit dem Titel „Output Upload“
Abschnitt mit dem Titel 'Output Upload'| CLI Flag | Umgebungsvariable | Zugriffschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | BUILD_OUTPUT_UPLOAD_ENABLED | false | Upload von Build-Ergebnissen (IPA/APK/AAB) auf Capgo-Speicher. Wenn über Umgebungsvariable gesetzt, verwenden BUILD_OUTPUT_UPLOAD_ENABLED=true. |
--no-output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | — | — | Deaktivieren Sie die Uploads von Build-Ergebnissen. Wenn über Umgebungsvariable gesetzt, verwenden BUILD_OUTPUT_UPLOAD_ENABLED=false. |
--output-retention <duration> | BUILD_OUTPUT_RETENTION_SECONDS | BUILD_OUTPUT_RETENTION_SECONDS | 1h | Wie lange bleiben Download-Links aktiv |
--output-record <path> | — | — | — | Nach erfolgreichem Build wird ein JSON-Record (Job-ID, Status, Download-URL, QR-code) geschrieben <path> — lesen Sie es zurück mit build last-output. |
Speicherrichtlinie: Verwenden Sie menschenlesbare Dauerangaben wie 1h, 6h, 2d, 7dMindestens 1 Stunde, höchstens 7 Tage. Wenn über Umgebungsvariable gesetzt, verwenden Sie Sekunden (z.B. für 1 Stunde). 3600 Build Cache
Abschnitt: Build Cache
__CAPGO_KEEP_0__ speichert kompilierte native Artefakte (CocoaPods, Gradle und verwandte Build-Ergebnisse)Capgo saves compiled native artifacts (CocoaPods, Gradle, and related build outputs) so beginnen wiederholte Builds schneller. Build Cache ist standardmäßig aktiviert pro App. __CAPGO_KEEP_0__ Flag
| CLI Feld | API field | Default | Beschreibung |
|---|---|---|---|
--no-cache | cache_enabled: false | Cache aktivieren | Cache für diese Build deaktivieren: Restore vermeiden und speichere keine neue Eintragung |
--cache-key <value> | cache_key | (vermeide) | Teile den Cache (z.B. prod, stagingvermeide für eine gemeinsame Cacheinstanz pro App |
CLI-Äquivalente: build request akzeptiert --no-cache und --cache-key.
CLI examples:
# 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 Beispiele: (when your integration calls Capgo Build directly):
{ "platform": "android", "cache_key": "prod"}für den gemeinsamen allgemeinen Cache. Setzen cache_key und cache_key um die Umgebungen zu partitionieren. Setzen Sie "cache_enabled": false um den Cache für eine einzelne Anfrage zu deaktivieren (gleichbedeutend mit --no-cache).
Wenn ein Build erfolgreich aussieht, aber das Artefakt falsch ist – oder ein Android AAB fehlt, nachdem RC gegenüber Produktionsumgebungen gewechselt wurde – versuchen Sie einen dedizierten Cache-Schlüssel oder eine einmalige --no-cache build. Siehe Fehlende Cache-Wiederherstellung: Fehlende Cache-Wiederherstellung.
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“Fertig zum Kopieren in Ihre CI/CD-Pipeline. Alle Variablen sind optional – setzen Sie nur, 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"Zugriffsspeicherung
Abschnitt mit dem Titel „Zugriffsspeicherung“Sichere Anmeldeinformationen lokal
Abschnitt mit dem Titel „Sichere Anmeldeinformationen lokal“Stattdessen müssen Sie keine Flags oder Umgebungsvariablen mehr jederzeit angeben, sondern können die Anmeldeinformationen einmalig 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.jsonSpeicherorte
Sektion mit dem Titel “Speicherorte”| Flagge | Ort | Anwendungsbereich |
|---|---|---|
| Standard | ~/.capgo-credentials/credentials.json | Global — auf allen Projekten auf Ihrem Computer gemeinsam |
--local | .capgo-credentials.json im Projektroot | Projektbezogen — überschreibt Global, wenn beide existieren |
Die Anmeldeinformationen werden durch Anwendungs-ID (z.B. com.example.myapp), so ein einzelnes Anmeldeinformationen-File kann Einstellungen für mehrere Apps ohne Konflikte speichern. Jede App-Anmeldeinformationen werden weiterhin durch die Plattform getrennt (ios / android).
Verwalten von gespeerten Anmeldeinformationen
Sektion mit dem Titel “Verwalten von gespeerten Anmeldeinformationen”# 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
Sektion mit dem Titel “Beispiele”Aktionen GitHub
Abschnitt mit dem Titel „Aktionen GitHub“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 }}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“Kombinieren Sie gespeicherte Anmeldeinformationen 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 Signaturregister während CLI Flagge die Ausführung des Buildverhaltens für diese spezifische Ausführung überschreibt.