Konfigurationsoptionen
Ein kopierbarer Einrichtungsvorschlag mit den Installationsanweisungen und der vollständigen Markdown-Guideline für diesen Plugin.
Vollständige Referenz für jede Cloud Build-Konfigurationsoption. Verwenden Sie diese Seite, um die CLI Flagge, Umgebungsvariable oder Zugriffsschlüssel für jede Build-Einstellung zu finden.
Konfigurationsvorherrschaft
Abschnitt mit dem Titel „Konfigurationsvorherrschaft“Jede Buildoption kann auf mehrere Weise gesetzt werden. Wenn die gleiche 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 auf dem 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-kodiert .p12 Verteilungszertifikat |
--ios-provisioning-profile <map> | CAPGO_IOS_PROVISIONING_MAP | CAPGO_IOS_PROVISIONING_MAP | — | Provisioning-Profil als path Wiederholbar für Mehrfachziel-Anwendungen (App + Erweiterungen); der Profilname wird automatisch extrahiert. bundleId=path Festlegung für das |
--p12-password <password> | P12_PASSWORD | P12_PASSWORD | — | Zertifikats-Passwort (überspringen, wenn das Zertifikat kein Passwort hat) .p12 Authentifizierung für App Store Connect |
Sektion mit dem Titel “Authentifizierung für App Store Connect”
__CAPGO_KEEP_0__ Flagge| CLI Flag | Benutzerschlüssel | Standard | Beschreibung | App Store Connect __CAPGO_KEEP_0__ Schlüssel-ID |
|---|---|---|---|---|
--apple-key-id <id> | APPLE_KEY_ID | APPLE_KEY_ID | — | App Store Connect API Key ID |
--apple-issuer-id <id> | APPLE_ISSUER_ID | APPLE_ISSUER_ID | — | App Store Connect Issuer ID (UUID) |
--apple-key-content <content> | APPLE_KEY_CONTENT | APPLE_KEY_CONTENT | — | Base64-codierter 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 |
iOS-Build-Einstellungen
Einstellungen für iOS-Builds| CLI Flag | Umgebungsvariable | Benutzerschlü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
Sektion mit dem Titel “Android-Optionen”Sicherheitskasten-Zertifizierung
Abschnitt mit dem Titel „Sicherheitskasten-Zertifizierung“| CLI Flag | Umgebungsvariable | Benutzernamen-Schlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--android-keystore-file <keystore> | ANDROID_KEYSTORE_FILE | ANDROID_KEYSTORE_FILE | — | Bas64-codierter Sicherheitskasten-Datei (.keystore oder .jks) |
--keystore-key-alias <alias> | KEYSTORE_KEY_ALIAS | KEYSTORE_KEY_ALIAS | key0 | Sicherheitskasten-Schlüsselalias |
--keystore-key-password <password> | KEYSTORE_KEY_PASSWORD | KEYSTORE_KEY_PASSWORD | — | Sicherheitskasten-Schlüsselpasswort (fällt zurück auf Speicher-Schlüsselpasswort, wenn nicht gesetzt) |
--keystore-store-password <password> | KEYSTORE_STORE_PASSWORD | KEYSTORE_STORE_PASSWORD | — | Sicherheitskasten-Speicher-Schlüsselpasswort |
Google Play-Konfiguration
Abschnitt mit dem Titel „Google Play-Konfiguration“| CLI Flagge | Umgebungsvariable | Zugriffsschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--play-config-json <json> | PLAY_CONFIG_JSON | PLAY_CONFIG_JSON | — | Bas64-kodierte Google Play-Dienstkontoinformationen im JSON-Format |
| (umgebungsbezogen) | PLAY_STORE_TRACK | — | internal | Google Play-Veröffentlichungsstrecke (internal, alpha, beta, production) |
| (umgebungsbezogen) | PLAY_STORE_RELEASE_STATUS | — | draft | Freigabestatus auf der gewählten Strecke (draft, completed, inProgress, halted) |
Android Build Einstellungen
Sektion mit dem Titel “Android Build Einstellungen”| CLI Flag | Standard | Beschreibung |
|---|---|---|
--android-flavor <flavor> | — | Produktflavor zum Bauen (z.B. production). Zwingend falls Ihr Projekt mehrere Flavours definiert. |
--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 Play Store-Upload auslassen (erfordert --output-upload). |
Build-Kontroll-Optionen
Sektion mit dem Titel “Build-Kontroll-Optionen”Diese Optionen funktionieren für beide iOS- und Android-Builds.
Build Modus
Abschnitt mit dem Titel “Build Modus”| CLI Flagge | Standard | Beschreibung |
|---|---|---|
--platform <platform> | — | Erforderlich. ios oder android |
--build-mode <mode> | release | debug oder release |
--path <path> | . | Projektverzeichnis |
--verbose | false | Aktivieren Sie die ausführliche Protokollierung des Build-Prozesses |
--ai-analytics | false | Bei Build-Fehlern werden die Protokolle an die Capgo-KI zur Diagnose geschickt — siehe KI-Bau-Diagnose |
Build-Zahl-Kontrolle
Abschnitt mit dem Titel „Build-Zahl-Kontrolle“| CLI-Flag | Umgebungsvariable | Zugriffschlüssel | Standard | Beschreibung |
|---|---|---|---|---|
--skip-build-number-bump | SKIP_BUILD_NUMBER_BUMP | SKIP_BUILD_NUMBER_BUMP | false | Automatische Build-Zahl-/Version code-Zählung überspringen |
--no-skip-build-number-bump | — | — | — | Expizit Auto-Zählung (überschreibt gespeicherte Zugriffsdaten) wiedereinrichten |
Standardmäßig Capgo Cloud Build zählt die Build-Zahlen automatisch:
- iOS: Die neueste Buildnummer aus App Store Connect abruft, erhöht sie um 1
- Android: Die maximale Buildnummer
versionCodeaus Google Play abruft, erhöht sie um 1
Wenn --skip-build-number-bump festgelegt ist, verwendet die Build die Version, die bereits in Ihren Projektdateien (Xcode-Projekt oder build.gradle).
Ausgabeanhänge
Sektion mit dem Titel “Ausschüttung hochladen”| Wichtige Flagge CLI | Umgebungsvariable | Zugriffsschlüssel | Standardwert | Beschreibung |
|---|---|---|---|---|
--output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | BUILD_OUTPUT_UPLOAD_ENABLED | false | Upload Buildausgaben (IPA/APK/AAB) auf Capgo-Speicher. Wenn über Umgebungsvariable gesetzt, verwenden BUILD_OUTPUT_UPLOAD_ENABLED=true. |
--no-output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | — | — | Ausgabeupload 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 bleiben Downloadlinks aktiv |
--output-record <path> | — | — | — | Nach erfolgreichem Build wird ein JSON-Record (Job-ID, Status, Download-URL, QR-Code code) geschrieben <path> — lesen Sie es wieder mit build last-output. |
Speicherformat: Verwenden Sie lesbare Dauerangaben wie 1h, 6h, 2d, 7d. Mindestens 1 Stunde, höchstens 7 Tage. Wenn über Umgebungsvariable gesetzt, verwenden Sekunden (z.B., 3600 Authentifizierung
Abschnitt mit dem Titel „Authentifizierung“
Upload build outputs (IPA/APK/AAB) to __CAPGO_KEEP_0__ storage. When set via env var, use| CLI Flag | Umgebungsvariable | Standard | Beschreibung |
|---|---|---|---|
-a, --apikey <key> | CAPGO_TOKEN | — | Capgo API Schlüssel für die Authentifizierung |
--supa-host <host> | — | — | Benutzerdefinierte Supabase-Host (nur Selbsthosting) |
--supa-anon <key> | — | — | Benutzerdefinierte Supabase-Anon-Key (nur Selbsthosting) |
Schnellreferenz für Umgebungsvariablen
Abschnitt mit dem Titel ‘Schnellreferenz für Umgebungsvariablen’Fertig zum Kopieren und Einsetzen in deinem CI/CD-Pipeline. Alle Variablen sind optional – setze nur das, was du benötigst.
# 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"
# 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“Sicherheitsdaten lokal speichern
Abschnitt mit dem Titel „Sicherheitsdaten lokal speichern“Stattdessen müssen Sie die Flags oder Umgebungsvariablen nicht mehr jederzeit eingeben, sondern die Sicherheitsdaten 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.jsonSpeicherorte
Abschnitt mit dem Titel „Speicherorte“| Flagge | Standort | Verwendungsfall |
|---|---|---|
| (Standard) | ~/.capgo-credentials/credentials.json | Global — auf allen Projekten auf Ihrem Computer geteilt |
--local | .capgo-credentials.json In Projektroot | Projektübergreif — überschreibt globale, wenn beide existieren |
Die Anmeldeinformationen sind nach Anwendungs-ID (z.B. com.example.myapp), so kann ein einzelner Anmeldeinformationen-Datei Einstellungen für mehrere Anwendungen ohne Konflikte speichern. Jede Anwendung ist zudem noch nach Plattform (ios / android).
Verwalten Sie gespeicherte Anmeldeinformationen
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 „Mit 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: MischkonfigurationCombiniere gespeicherte Anmeldeinformationen mit CLI-Überwritten:
# 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 Buildverhalten für diese spezifische Ausführung überschreiben.