跳过内容

配置选项

每个 Cloud Build 配置选项的完整参考。使用此页面查找任何构建设置的CLI标志、环境变量或凭据密钥。

每个构建选项都可以在多种方式中设置。同一个选项在多个地方设置时,优先级更高的来源会获胜:

示例: 如果您保存的凭据有 SKIP_BUILD_NUMBER_BUMP=true 但您传递 --no-skip-build-number-bump 在 CLI 上,CLI flag 将获胜,且构建号将自动递增。


标题:iOS 选项

__CAPGO_KEEP_0__ 签名

标题:Code 签名

Code 标志
CLI Flag凭证密钥避免每次都重复输入标志。默认描述
--build-certificate-base64 <cert>BUILD_CERTIFICATE_BASE64BUILD_CERTIFICATE_BASE64Base64编码 .p12 分发证书
--ios-provisioning-profile <map>CAPGO_IOS_PROVISIONING_MAPCAPGO_IOS_PROVISIONING_MAPpathbundleId=path 映射。可重复使用多目标应用(应用程序+扩展);配置文件名称将自动提取。
--p12-password <password>P12_PASSWORDP12_PASSWORD用于分发证书的密码(如果证书没有密码,则省略) .p12 App Store Connect身份验证

App Store Connect身份验证

__CAPGO_KEEP_0__标志
CLI Flag环境变量凭据密钥默认值描述
--apple-key-id <id>APPLE_KEY_IDAPPLE_KEY_IDApp Store Connect API 密钥 ID
--apple-issuer-id <id>APPLE_ISSUER_IDAPPLE_ISSUER_IDApp Store Connect 发行者 ID (UUID)
--apple-key-content <content>APPLE_KEY_CONTENTAPPLE_KEY_CONTENTBase64编码的 App Store Connect API 密钥 (.p8 文件)
--app-store-connect-team-id <id>APP_STORE_CONNECT_TEAM_IDAPP_STORE_CONNECT_TEAM_IDApp Store Connect 团队 ID
App Store Connect
CLI Flag应用特定密码认证(不推荐)__CAPGO_KEEP_0__ Flag环境变量凭证密钥
--apple-id <email>FASTLANE_USERFASTLANE_USER默认
--apple-app-specific-password <password>FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORDFASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD描述xxxx-xxxx-xxxx-xxxx应用的所有者账户的 Apple ID 电子邮件地址 appleid.apple.com
--apple-app-id <id>APPLE_APP_IDAPPLE_APP_IDApp Store Connect数字应用ID(例如 1234567890)
CLI标志环境变量凭证密钥默认值概述
--ios-scheme <scheme>CAPGO_IOS_SCHEMECAPGO_IOS_SCHEMEAppXcode 构建方案
--ios-target <target>CAPGO_IOS_TARGETCAPGO_IOS_TARGETAppXcode 构建目标
--ios-distribution <mode>CAPGO_IOS_DISTRIBUTIONCAPGO_IOS_DISTRIBUTIONapp_store发布模式: app_storead_hoc

选择最佳方案

选择最佳方案

选择最佳方案

__CAPGO_KEEP_0__ 标志
CLI Flag凭证密钥安卓选项默认描述
--android-keystore-file <keystore>ANDROID_KEYSTORE_FILEANDROID_KEYSTORE_FILEBase64编码的密钥存储文件(.keystore.jks)
--keystore-key-alias <alias>KEYSTORE_KEY_ALIASKEYSTORE_KEY_ALIASkey0密钥存储文件别名
--keystore-key-password <password>KEYSTORE_KEY_PASSWORDKEYSTORE_KEY_PASSWORD密钥存储文件密码(如果未设置则回退到存储密码)
--keystore-store-password <password>KEYSTORE_STORE_PASSWORDKEYSTORE_STORE_PASSWORD密钥存储文件存储密码

Google Play配置

Google Play配置
CLI标志环境变量凭证密钥默认描述
--play-config-json <json>PLAY_CONFIG_JSONPLAY_CONFIG_JSONBase64编码的Google Play服务账户JSON密钥
--android-track <track>PLAY_STORE_TRACKPLAY_STORE_TRACKinternal (或 production--submit-to-store-review)Google Play发布跟踪(internal, alpha, beta, production). Forwarded from CI env / CLI into the build runner.
--android-release-status <status>PLAY_STORE_RELEASE_STATUSPLAY_STORE_RELEASE_STATUSdraft 从CI环境/ __CAPGO_KEEP_0__转发到构建运行器。 completed (或 --submit-to-store-review)draft, completed, inProgress, halted在选择的跟踪上发布的状态( --submit-to-store-review

Android 构建设置

Android 构建设置标题
CLI 标志默认描述
--android-flavor <flavor>要构建的产品风味(例如 production). 必填 如果您的项目定义了多个风味。
--android-track <track>internalGoogle Play 上传的跟踪。没有设置跟踪时,__CAPGO_KEEP_0__ 默认为 --submit-to-store-review Google Play 上传的状态。没有设置状态时,Capgo 默认为 production.
--android-release-status <status>draftGoogle Play 发布状态。没有设置状态时,__CAPGO_KEEP_0__ 默认为 --submit-to-store-review Google Play 正式发布状态。没有设置状态时,Capgo 默认为 completed.
--in-app-update-priority <0–5>Google Play内应用更新优先级(更高=更紧急)。
--no-playstore-upload构建和签名,但跳过Play商店上传(需要 --output-upload).

构建控制选项

构建控制选项

这两个选项都适用于iOS和Android构建。

构建模式

构建模式
CLI标志默认描述
--platform <platform>必填。 iosandroid
--build-mode <mode>releasedebugrelease
--path <path>.项目目录
--verbosefalse启用详细构建日志
--ai-analyticsfalse构建失败时,发送日志到Capgo AI 进行诊断 — 见 AI 构建诊断
CLI 标志环境变量凭证密钥默认描述
--skip-build-number-bumpSKIP_BUILD_NUMBER_BUMPSKIP_BUILD_NUMBER_BUMPfalse跳过自动构建号/版本 code 自动递增
--no-skip-build-number-bump显式重新启用自动递增(覆盖保存的凭据)

默认情况下,Capgo Cloud Build 将自动递增构建号:

  • iOS: 从 App Store Connect 获取最新的构建号,递增 1
  • Android: 从 Google Play 获取最大值 versionCode

设置时,构建将使用项目文件(Xcode 项目或)中的版本(Xcode 项目或 --skip-build-number-bump 输出上传 build.gradle).

输出上传

输出上传
CLI 标志环境变量凭证密钥默认值描述
--output-uploadBUILD_OUTPUT_UPLOAD_ENABLEDBUILD_OUTPUT_UPLOAD_ENABLEDfalse将构建输出 (IPA/APK/AAB) 上传到 Capgo 存储中。当通过环境变量设置时,使用 BUILD_OUTPUT_UPLOAD_ENABLED=true.
--no-output-uploadBUILD_OUTPUT_UPLOAD_ENABLED禁用输出上传。当通过环境变量设置时,使用 BUILD_OUTPUT_UPLOAD_ENABLED=false.
--output-retention <duration>BUILD_OUTPUT_RETENTION_SECONDSBUILD_OUTPUT_RETENTION_SECONDS1h下载链接保持活动时间
--output-record <path>成功构建后,写入一个 JSON 记录 (作业 ID、状态、下载 URL、QR code) 到 <path> — 使用 build last-output.

保留格式: 使用人类可读的持续时间,如 1h, 6h, 2d, 7d. 最小值为 1 小时,最大值为 7 天。当通过环境变量设置时,使用秒(例如,1 小时)。 3600 for 1 小时).

Capgo 保存编译的原生艺术品(CocoaPods,Gradle 和相关构建输出) 每个应用程序 以便重复构建可以更快地启动。 构建缓存默认启用 每个应用程序。

CLI 标志API 字段默认值简介
--no-cachecache_enabled: false缓存开启禁用此次构建缓存:跳过恢复 并且 不要保存新的条目
--cache-key <value>cache_key(省略)分区缓存(例如 prod, staging) 省略一个共享的通用缓存

CLI 等价物: build request 接受 --no-cache 并且 --cache-key.

CLI examples:

__CAPGO_KEEP_0__示例:
# Default: restore/save the shared per-app cache
bunx @capgo/cli@latest build request com.example.app --platform android
# Separate caches per environment
bunx @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-cache

API / webhook payload Capgo / webhook payload

{
"platform": "android",
"cache_key": "prod"
}

复制到剪贴板 cache_key 忽略 cache_key 根据环境进行分区。设置 "cache_enabled": false 禁用单个请求的缓存(与 --no-cache).

如果一个构建看起来成功,但 artifact 是错误的 — 或在切换 RC 与生产时 Android AAB 缺失 — 试试一个专门的缓存键或一个一次性的 --no-cache 查看 错误的缓存恢复:.

CLI 标志环境变量默认值描述
-a, --apikey <key>CAPGO_TOKENCapgo API 用于身份验证的密钥
--supa-host <host>自定义 Supabase 主机(仅限自主托管)
--supa-anon <key>自定义 Supabase 匿名密钥(仅限自主托管)

环境变量快速参考

环境变量快速参考

复制粘贴以便于 CI/CD pipeline。所有变量都是可选的 — 只设置您需要的变量。

iOS

iOS
终端窗口
# 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 settings
CAPGO_IOS_SCHEME="App"
CAPGO_IOS_TARGET="App"

Android

Android
终端窗口
# 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 settings
PLAY_STORE_TRACK="internal"
PLAY_STORE_RELEASE_STATUS="draft"

构建控制

构建控制
终端窗口
# Build behavior
SKIP_BUILD_NUMBER_BUMP="true" # Skip auto-increment
BUILD_OUTPUT_UPLOAD_ENABLED="true" # Upload IPA/APK/AAB
BUILD_OUTPUT_RETENTION_SECONDS="3600" # 1 hour download link
# Authentication
CAPGO_TOKEN="your-api-key"

凭据存储

凭据存储

保存凭据

保存凭据

而不是每次都传递标志或环境变量,保存凭据一次:

终端窗口
# Save iOS credentials
bunx @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 credentials
bunx @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.json

存储位置

存储位置
标志位置使用场景
默认~/.capgo-credentials/credentials.json全局 — 在您的机器上所有项目共享
--local.capgo-credentials.json 在项目根目录按项目 — 覆盖全局

凭据按应用程序 ID 键 (例如 (例如 com.example.myapp)、因此一个单独的凭据文件可以存储多个应用程序的设置而无冲突。每个应用程序的凭据还分为平台 (ios / android).

标题:管理保存的凭据

终端窗口
复制到剪贴板
# List saved credentials
bunx @capgo/cli@latest build credentials list
# Update a specific option without re-entering everything
bunx @capgo/cli@latest build credentials update --skip-build-number-bump
# Clear saved credentials
bunx @capgo/cli@latest build credentials clear --platform ios

区域/页面:漏洞赏金计划页面。角色:部分或页面标题。见:页面bug-bounty.astro。消息键`bug_bounty_supabase_examples_title`(漏洞赏金计划Supabase示例标题)。

标题:示例
name: Build and Submit
on:
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 参数

标题:直接使用 CLI 参数
终端窗口
# Build iOS with all options inline
bunx @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 upload
bunx @capgo/cli@latest build request \
--platform android \
--skip-build-number-bump \
--no-output-upload \
--apikey YOUR_API_KEY

将保存的凭据与 CLI 覆盖项结合:

终端窗口
# Save base credentials once
bunx @capgo/cli@latest build credentials save --platform ios \
--certificate ./cert.p12 \
--ios-provisioning-profile ./profile.mobileprovision \
--output-upload
# Override specific options per-build
bunx @capgo/cli@latest build request --platform ios \
--skip-build-number-bump \
--output-retention 2d

已保存的凭据提供签名详细信息,而 CLI 标志会覆盖此特定运行的构建行为。