Options de configuration
Copiez une invite de configuration avec les étapes d'installation et le guide Markdown complet pour ce plugin.
Référence complète pour chaque option de configuration de Cloud Build. Utilisez cette page pour trouver la CLI drapeau, la variable d'environnement ou la clé de la clé de confiance pour toute configuration de build.
Prééminence de la configuration
Sous-titre « Prééminence de la configuration »Chaque option de build peut être définie de plusieurs manières. Lorsque la même option est définie de plusieurs manières, les sources de plus haute priorité gagnent :
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
Exemple : Si vos informations d'identification enregistrées ont SKIP_BUILD_NUMBER_BUMP=true mais vous passez --no-skip-build-number-bump sur le CLI, le drapeau CLI gagne et les numéros de build seront incrémentés automatiquement.
Options iOS
Section intitulée « Options iOS »Code Signature
Section intitulée « Code Signature »| CLI Drapeau | Variable d'environnement | Clé de connexion | Défaut | Description |
|---|---|---|---|---|
--build-certificate-base64 <cert> | BUILD_CERTIFICATE_BASE64 | BUILD_CERTIFICATE_BASE64 | — | encodé en Base64 .p12 dossier de certificat |
--ios-provisioning-profile <map> | CAPGO_IOS_PROVISIONING_MAP | CAPGO_IOS_PROVISIONING_MAP | — | profil de provisionnement comme un path ou bundleId=path ou |
--p12-password <password> | P12_PASSWORD | P12_PASSWORD | — | certificat de distribution .p12 comme un |
profil de provisionnement
ou| CLI Flag | mot de passe pour le | certificat (omettre si le certificat n'a pas de mot de passe) | Par défaut | Description |
|---|---|---|---|---|
--apple-key-id <id> | APPLE_KEY_ID | APPLE_KEY_ID | — | Clé d'App Store Connect API |
--apple-issuer-id <id> | APPLE_ISSUER_ID | APPLE_ISSUER_ID | — | Identifiant émetteur d'App Store Connect (UUID) |
--apple-key-content <content> | APPLE_KEY_CONTENT | APPLE_KEY_CONTENT | — | Clé d'App Store Connect API codée en Base64 (.p8 fichier) |
--app-store-connect-team-id <id> | APP_STORE_CONNECT_TEAM_ID | APP_STORE_CONNECT_TEAM_ID | — | Identifiant d'équipe d'App Store Connect |
Authentification par mot de passe spécifique à l'application (non recommandée)
Section intitulée « Authentification par mot de passe spécifique à l'application (non recommandée) »| CLI Flag | Variable d'environnement | Clé de mot de passe | Défaut | Description |
|---|---|---|---|---|
--apple-id <email> | FASTLANE_USER | FASTLANE_USER | — | Adresse e-mail de l'ID Apple de la mise en relation qui possède l'application |
--apple-app-specific-password <password> | FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD | FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD | — | Mot de passe spécifique à l'application («xxxx-xxxx-xxxx-xxxx) généré à appleid.apple.com |
--apple-app-id <id> | APPLE_APP_ID | APPLE_APP_ID | — | Identifiant numérique d'application Apple Store Connect (par exemple 1234567890) |
Paramètres de Build iOS
Section intitulée « Paramètres de Build iOS »| Drapeau CLI | Variable d'environnement | Clé de l'authentification | Par défaut | Description |
|---|---|---|---|---|
--ios-scheme <scheme> | CAPGO_IOS_SCHEME | CAPGO_IOS_SCHEME | App | Nom de schéma Xcode à construire |
--ios-target <target> | CAPGO_IOS_TARGET | CAPGO_IOS_TARGET | App | Configuration de cible Xcode pour la lecture des paramètres de construction |
--ios-distribution <mode> | CAPGO_IOS_DISTRIBUTION | CAPGO_IOS_DISTRIBUTION | app_store | Mode de distribution : app_store ou ad_hoc |
Alternatives : ou comment choisir entre Capacitor et Appflow ?
Options AndroidOptions Android
Signature de clé de keystore| CLI Flag | Drapeau __CAPGO_KEEP_0__ | Variable d'environnement | Clef de crédential | Par défaut |
|---|---|---|---|---|
--android-keystore-file <keystore> | ANDROID_KEYSTORE_FILE | ANDROID_KEYSTORE_FILE | — | Base64-encoded fichier de clé de coffre (.keystore ou .jks) |
--keystore-key-alias <alias> | KEYSTORE_KEY_ALIAS | KEYSTORE_KEY_ALIAS | key0 | Clé d'alias de coffre |
--keystore-key-password <password> | KEYSTORE_KEY_PASSWORD | KEYSTORE_KEY_PASSWORD | — | Mot de passe de clé de coffre (retourne au mot de passe de magasin si non défini) |
--keystore-store-password <password> | KEYSTORE_STORE_PASSWORD | KEYSTORE_STORE_PASSWORD | — | Mot de passe de magasin de coffre |
Configuration Google Play
Section intitulée « Configuration Google Play »| Drapeau CLI | Variable d'environnement | Clé de credenciaux | Par défaut | Description |
|---|---|---|---|---|
--play-config-json <json> | PLAY_CONFIG_JSON | PLAY_CONFIG_JSON | — | Clé JSON de compte Google Play codée en Base64 |
--android-track <track> | PLAY_STORE_TRACK | PLAY_STORE_TRACK | internal (ou) production avec --submit-to-store-review) | piste de publication Google Play (internal, alpha, beta, production). Transféré à partir de l'environnement CI / CLI vers le lancer de build. |
--android-release-status <status> | PLAY_STORE_RELEASE_STATUS | PLAY_STORE_RELEASE_STATUS | draft (ou) completed avec --submit-to-store-review) | Statut de publication sur la piste choisie (draft, completed, inProgress, halted). Les valeurs explicites remplacent la valeur par défaut. --submit-to-store-review Paramètres de build Android |
Section intitulée « Paramètres de build Android »
Section intitulée « Paramètres de build Android »| CLI Flag | Défaut | Description |
|---|---|---|
--android-flavor <flavor> | — | Flavon de produit à construire (par exemple production). Requis si votre projet définit plusieurs saveurs. |
--android-track <track> | internal | Piste Google Play pour ce téléchargement. Avec --submit-to-store-review et aucune piste définie, Capgo se définit par production. |
--android-release-status <status> | draft | statut de publication Google Play. Avec --submit-to-store-review et aucun statut défini, Capgo se définit par completed. |
--in-app-update-priority <0–5> | — | priorité de mise à jour en application Google Play pour cette mise à jour (plus élevé = plus urgent). |
--no-playstore-upload | — | Construire et signer, mais passer outre l'upload sur Google Play Store (exige --output-upload). |
Options de contrôle de la construction
Section intitulée « Options de contrôle de la construction »Ces options fonctionnent pour les builds iOS et Android.
Mode de construction
Section intitulée « Mode de construction »| Drapeau CLI | Par défaut | Description |
|---|---|---|
--platform <platform> | — | Requis. ios ou android |
--build-mode <mode> | release | debug ou release |
--path <path> | . | Répertoire du projet |
--verbose | false | Activer la journalisation détaillée de la construction |
--ai-analytics | false | En cas d'échec de la construction, envoyer les journaux à Capgo IA pour le diagnostic — voir Diagnostic de construction par IA |
Contrôle du numéro de construction
Section intitulée « Contrôle du numéro de construction »| CLI Flag | Variable d'environnement | Clé de crédential | Défaut | Description |
|---|---|---|---|---|
--skip-build-number-bump | SKIP_BUILD_NUMBER_BUMP | SKIP_BUILD_NUMBER_BUMP | false | Ignorer l'incrémentation automatique du numéro de construction / version code |
--no-skip-build-number-bump | — | — | — | Réactiver explicitement l'incrémentation automatique (annule les crédentiels sauvegardés) |
Par défaut, Capgo Cloud Build incrémente automatiquement les numéros de build :
- iOS : Récupère le dernier numéro de build depuis App Store Connect, incrémente de 1
- Android : Récupère le max
versionCodede Google Play, incrémente de 1
Lorsque --skip-build-number-bump est défini, la build utilise la version qui est déjà dans vos fichiers de projet (projet Xcode ou build.gradle).
Section intitulée « Output Upload »
Drapeau __CAPGO_KEEP_0__| CLI Flag | Section intitulée « Output Upload » | Clé de l'authentification | Défaut | Description |
|---|---|---|---|---|
--output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | BUILD_OUTPUT_UPLOAD_ENABLED | false | Télécharger les résultats de construction (IPA/APK/AAB) vers le stockage Capgo. Lorsqu'il est défini via une variable d'environnement, utilisez BUILD_OUTPUT_UPLOAD_ENABLED=true. |
--no-output-upload | BUILD_OUTPUT_UPLOAD_ENABLED | — | — | Désactiver l'upload des résultats de construction. Lorsqu'il est défini via une variable d'environnement, utilisez BUILD_OUTPUT_UPLOAD_ENABLED=false. |
--output-retention <duration> | BUILD_OUTPUT_RETENTION_SECONDS | BUILD_OUTPUT_RETENTION_SECONDS | 1h | Durée pendant laquelle les liens de téléchargement restent actifs |
--output-record <path> | — | — | — | Après une construction réussie, écrire un enregistrement JSON (ID de tâche, statut, URL de téléchargement, QR code) à <path> — lire à nouveau avec build last-output. |
Format de conservation : Utiliser des durées lisibles par l'homme comme 1h, 6h, 2d, 7dMinimum est 1 heure, maximum est 7 jours. Lorsqu'il est défini via une variable d'environnement, utilisez des secondes (par exemple, 3600 pour 1 heure).
Authentification
Section intitulée « Authentification »| CLI Flag | Variable d'environnement | Défaut | Clé __CAPGO_KEEP_0__ __CAPGO_KEEP_1__ pour l'authentification |
|---|---|---|---|
-a, --apikey <key> | CAPGO_TOKEN | — | Capgo API key for authentication |
--supa-host <host> | — | — | Clé anonyme Supabase personnalisée (hébergement autonome uniquement) |
--supa-anon <key> | — | — | Référence rapide des variables d'environnement |
Section intitulée « Référence rapide des variables d'environnement »
Prêt à copier-coller pour votre pipeline CI/CD. Toutes les variables sont optionnelles — n'ajoutez que ce dont vous avez besoin.Configuration de l'authentification
# 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"Contrôle de construction
Section intitulée « Contrôle de construction »# 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"Stockage des informations d'identification
Section intitulée « Stockage des informations d'identification »Enregistrer les informations d'identification localement
Section intitulée « Enregistrer les informations d'identification localement »Enfin, enregistrez les informations d'identification une seule fois au lieu de passer des drapeaux ou des variables d'environnement à chaque fois :
# 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.jsonLieux de stockage
Section intitulée « Lieux de stockage »| Drapeau | Lieu | Utilisation du cas d'usage |
|---|---|---|
| (par défaut) | ~/.capgo-credentials/credentials.json | Globale — partagée par tous les projets sur votre machine |
--local | .capgo-credentials.json dans le répertoire root du projet | Par projet — remplace la configuration globale lorsqu'elles existent toutes les deux |
Les informations d'identification sont clés par ID d'application (par exemple com.example.myapp), de sorte qu'un seul fichier d'informations d'identification peut stocker les paramètres pour plusieurs applications sans conflits. Les informations d'identification de chaque application sont ensuite scindées par plateforme (ios / android).
Gérer les informations d'identification enregistrées
Sous-section intitulée « Gérer les informations d'identification enregistrées »# 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 iosGitHub Actions
Sous-section intitulée « GitHub Actions »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 }}Utilisation directe des drapeaux CLI
Sous-section intitulée « Utilisation directe des drapeaux CLI »# 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_KEYConfiguration mixte
Sous-section intitulée « Configuration mixte »Combinez les informations d'identification sauvegardées avec les CLI surcharges :
# 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 2dLes informations d'identification sauvegardées fournissent les détails de signature tandis que les drapeaux CLI définissent le comportement de construction pour cette exécution spécifique.