📦 打包
复制一个包含安装步骤和本插件的完整Markdown指南的设置提示
📦 为在 Capgo 云中部署应用程序包管理,包括上传、兼容性检查和加密。
⬆️ 上传
标题: ⬆️ 上传别名: u
npx @capgo/cli@latest bundle upload⬆️ 将新应用程序包上传到 Capgo 云以进行分发。 版本必须大于 0.0.0 并且唯一。已删除的版本不能重用以保证安全。 外部选项:仅存储 URL 链接(对于大于 200MB 的应用程序或隐私要求有用)。 Capgo 不会检查外部内容。添加加密以实现无信任安全。
示例:
npx @capgo/cli@latest bundle upload com.example.app --path ./dist --channel production,beta自动将下一个可用的 Semver 从频道 (或最新远程应用版本) 中升级,当您不传递时 (或最新远程应用版本)。 --bundle在 CI 中有用时 package.json 当 Capgo 已经匹配一个版本时:
npx @capgo/cli@latest bundle upload --channel=production --auto-bumpnpx @capgo/cli@latest bundle upload --auto-bump majornpx @capgo/cli@latest bundle upload --auto-bump minor # default when the flag has no valuenpx @capgo/cli@latest bundle upload --auto-bump patch # alias: fixnpx @capgo/cli@latest bundle upload --auto-bump metadatanpx @capgo/cli@latest bundle upload --channel=production --auto-bump ai使用 __CAPGO_KEEP_0__ __CAPGO_KEEP_1__ Workers AI 将本地捆绑文件与之前的 __CAPGO_KEEP_2__/频道 delta 清单进行比较,推断 --auto-bump ai, Capgo Cloudflare Workers AI compares local bundle files to the previous Capgo/channel delta manifest, infers major | minor | patch | metadata, and prints a short reason in the CLI log. If no previous Capgo version exists, AI is skipped and the bump defaults to 选项:.
protectedTokens
| 参数 | 类型 | 描述 |
|---|---|---|
| -a | string | API |
| -p | string | 上传文件夹的路径,如果不提供将使用capacitor.config中的webDir |
| -c | string | 要链接的频道,使用逗号分隔多个频道,例如production,beta |
| --rollout | string | 将上传的包作为此频道的滚动目标,百分比范围为0-100 |
| --rollout-percentage-bps | string | 设置从 0 到 10000 的上传包回滚百分比(基点) |
| —rollout-cache-ttl-seconds | string | Cloudflare 回滚决策缓存 TTL(秒) |
| -e | string | 将包链接到外部 URL 而不是上传到 Capgo 云 |
| —iv-session-key | string | 设置包 URL 外部的 IV 和会话密钥 |
| —s3-region | string | 您的 S3 存储桶所在的区域 |
| —s3-apikey | string | API 的 S3 端点密钥 |
| —s3-apisecret | string | API S3 端点的密钥 |
| —s3-endpoint | string | S3 端点的 URL |
| —s3-bucket-name | string | S3 存储桶的名称 |
| —s3-port | string | S3 端点的端口 |
| —no-s3-ssl | boolean | 禁用 S3 上传的 SSL |
| —key-v2 | string | 自定义私钥路径(v2 系统) |
| —key-data-v2 | string | 私有签名密钥(v2系统) |
| —bundle-url | boolean | 将包裹URL打印到标准输出 |
| —no-key | boolean | 忽略签名密钥并发送清晰的更新 |
| —no-code-check | boolean | 忽略源code和索引在根目录中的notifyAppReady()是否被调用 |
| —display-iv-session | boolean | 在控制台中显示用于加密更新的IV和会话密钥 |
| -b | string | 要上传的包裹版本号 |
| —auto-bump | string | 从频道关联的包中自动递增,否则使用最新的远程应用程序版本。级别:主版本,次版本(默认),修订版本(修订版本别名),元数据或ai(Worker AI根据本地与之前的delta清单推断级别;如果没有之前的Capgo版本,则回退到修订版本)。直到找到一个空闲的名称(删除的名称将占用)。不能与—包(-b)一起使用 |
| —关联 | string | 关联到外部资源(例如GitHub发布) |
| —评论 | string | 关于此版本的评论,可能是发布说明,提交哈希,提交消息等 |
| —最小更新版本 | string | 所需的最小版本才能更新到此版本。仅当频道的禁用自动更新设置为元数据时才使用 |
| —自动最小更新版本 | boolean | 基于本机包设置最小更新版本 |
| —忽略元数据检查 | boolean | 在上传时忽略元数据(node_modules)检查 |
| —在不兼容时失败 | boolean | 在上传时,若 bundle 与当前 channel 的本地包不兼容,则退出(非零退出码)而非上传。在交互式终端中,您仍可选择本地构建;拒绝则失败。不能与 —ignore-metadata-check 一起使用。 |
| —ignore-checksum-check | boolean | 忽略上传时的校验和检查 |
| —force-crc32-checksum | boolean | 强制 CRC32 校验和上传(覆盖自动检测) |
| —timeout | string | 上传过程超时时间(以秒为单位) |
| —multipart | boolean | 【已弃用】请使用 —tus。使用 multipart 协议进行 S3 上传 |
| —zip | boolean | 使用 zip 将 bundle 上传到 Capgo 云(遗代) |
| —tus | boolean | 使用 TUS 将包上传到 Capgo 云 |
| —tus-chunk-size | string | TUS 分段上传时的字节块大小(默认:自动) |
| —partial | boolean | [已弃用] 使用 —delta 代替。上传增量更新 |
| —partial-only | boolean | [已弃用] 使用 —delta-only 代替。仅上传增量更新,跳过完整包 |
| —delta | boolean | 上传差异更新(仅更改的文件)以实现实时、超快更新而不是大型 zip 下载 |
| —delta-only | boolean | 仅上传差异更新而不上传完整包以实现最大速度(适用于大型应用) |
| —no-delta | boolean | 禁用即时更新的delta更新 |
| —加密校验和 | string | 加密校验和(签名)。仅在上传外部包时使用 |
| —自动设置包 | boolean | 设置包在capacitor.config.json |
| —干燥上传 | boolean | 干燥上传包过程:在数据库中添加行而不上传文件或更新频道(由Capgo用于内部测试) |
| —package.json | string | 多包项目的package.json文件路径(用逗号分隔) |
| —node_modules | string | 多包项目的node_modules目录路径(用逗号分隔) |
| —部分加密 | boolean | 加密delta更新文件(自动启用更新器 > 6.14.4) |
| —删除上传时关联的包 | boolean | 在您尝试上传的频道中查找当前关联的包,并删除它 |
| —不压缩模式 | string | 要排除的文件(逗号分隔的模式,例如“.jpg.png”) |
| —禁用压缩 | boolean | 即使更新器版本支持它,也完全禁用 brotli压缩 |
| —如果版本存在则退出 | boolean | 如果存在包版本,则在CI/CD工作流程中有用,特别是对于多包项目 |
| —自我分配 | boolean | 允许设备自动加入此频道(更新频道设置) |
| —qr-preview | boolean | 打印终端二维码code用于此包预览 |
| —send-update-notification | boolean | 更新关联频道包后向设备发送本机更新检查通知 |
| —supa-host | string | 自定义 Supabase 主机 URL(用于自主托管或Capgo开发) |
| —supa-anon | string | 自定义 Supabase 匿名密钥(用于自主托管) |
| —verbose | boolean | 启用详细日志的verbose输出 |
npx @capgo/cli@latest bundle compatibility🧪 在 Capgo Cloud 中检查一个特定频道的包与 Capgo Cloud 的兼容性,以确保更新是安全的。
示例:
npx @capgo/cli@latest bundle compatibility com.example.app --channel production选项:
| 参数 | 类型 | 描述 |
|---|---|---|
| -a | string | API key to link to your account |
| -c | string | Channel to 检查与 |
| —text | boolean | 输出文本而不是表情符号 |
| —package-json | string | 多包项目的package.json文件路径(逗号分隔) |
| —node-modules | string | 多包项目的node_modules目录路径(逗号分隔) |
| —supa-host | string | 自定义Supabase主机URL(用于自托管或Capgo开发) |
| —supa-anon | string | 自定义 Supabase 匿名密钥(用于自主托管) |
🔹 发布类型
发布类型npx @capgo/cli@latest bundle releaseType🧭 根据与频道最新元数据的兼容性打印“原生”或“OTA”。
示例:
npx @capgo/cli@latest bundle releaseType com.example.app --channel production选项:
| 参数 | 类型 | 描述 |
|---|---|---|
| -a | string | API key to link to your account |
| -c | string | 与之比较的频道 |
| —package-json | string | 多包仓库的package.json文件路径(用逗号分隔) |
| —node-modules | string | 多包仓库的node_modules目录路径(用逗号分隔) |
| —supa-host | string | 自主托管或Capgo开发的自定义Supabase主机URL |
| —supa-anon | string | 自定义 Supabase 匿名密钥 (用于自主托管) |
🗑️ 删除
标题: “ 🗑️ 删除”别名: d
npx @capgo/cli@latest bundle delete🗑️ 从 Capgo 云中删除特定包,选项性地针对单个版本
示例:
npx @capgo/cli@latest bundle delete BUNDLE_ID com.example.app选项:
| 参数 | 类型 | 描述 |
|---|---|---|
| -a | string | API key to link to your account |
| —自定义 Supabase 主机 URL(适用于自主托管或 __CAPGO_KEEP_0__ 开发) | string | Custom Supabase host URL (for self-hosting or Capgo development) |
| 列表 | string | 标题:列表 |
📋 别名:
终端窗口—自定义 Supabase 主机 URL(适用于自主托管或 __CAPGO_KEEP_0__ 开发) l
npx @capgo/cli@latest bundle list📋 List all bundles uploaded for an app in Capgo Cloud.
示例:
npx @capgo/cli@latest bundle list com.example.app选项:
| 参数 | 类型 | 描述 |
|---|---|---|
| -a | string | API 的密钥以链接到您的帐户 |
| --supa-host | string | 自定义 Supabase 主机 URL(用于自主托管或 Capgo 开发) |
| —supa-anon | string | 自定义 Supabase 匿名密钥(用于自主托管) |
🧹 清理
标题:清理别名: c
npx @capgo/cli@latest bundle cleanup🧹 删除 Capgo 云中的旧包,保留指定数量的最近版本。 与频道相关的包除非使用 —ignore-channel,否则会被保留。
示例:
npx @capgo/cli@latest bundle cleanup com.example.app --bundle=1.0 --keep=3选项:
| 参数 | 类型 | 描述 |
|---|---|---|
| -b | string | 要删除的应用程序的包版本号 |
| -a | string | API |
| -k | string | 保留的版本数量 |
| -f | boolean | 强制删除 |
| —忽略频道 | boolean | 即使与频道相关联,也删除捆绑包(警告:也会删除频道) |
| —自定义主机 | string | Custom Supabase host URL (for self-hosting or Capgo development) |
| —自定义匿名密钥 | string | 自定义 Supabase 匿名密钥(用于自主托管) |
🔒 加密
标题:加密npx @capgo/cli@latest bundle encrypt🔒 对 zip 捆绑包进行安全外部存储加密。 返回用于上传/解密的 ivSessionKey。使用 ‘捆绑包 zip —json’ 获取校验和。
例子:
npx @capgo/cli@latest bundle encrypt ./myapp.zip CHECKSUM选项:
| 参数 | 类型 | 描述 |
|---|---|---|
| —key | string | 私有签名密钥的自定义路径 |
| —key-data | string | 私有签名密钥 |
| -j | boolean | 以 JSON 格式输出 |
| —package-json | string | 多包仓库的package.json文件路径(以逗号分隔) |
🔓 解密
解密npx @capgo/cli@latest bundle decrypt🔓 解密一个加密的包(主要用于测试)。 打印base64会话密钥以进行验证。
示例:
npx @capgo/cli@latest bundle decrypt ./myapp_encrypted.zip CHECKSUM选项:
| 参数: | 类型 | 描述 |
|---|---|---|
| —key | string | 自定义私钥路径 |
| —key-data | string | 私钥 |
| —checksum | string | 包的校验和,用于验证包的完整性 |
| —package-json | string | 多包项目的package.json文件路径(以逗号分隔) |
🔹 压缩包
标题:压缩包npx @capgo/cli@latest bundle zip🗜️ 将您的应用程序包打包成 zip 文件。 返回用于加密的校验和。使用 —json 可以获得机器可读的输出。
示例:
npx @capgo/cli@latest bundle zip com.example.app --path ./dist选项:
| 参数 | 类型 | 描述 |
|---|---|---|
| -p | string | 要上传的文件夹路径,如果未提供则会使用 capacitor.config 中的 webDir |
| -b | string | 打包版本号,用于命名 zip 文件 |
| -n | string | zip 文件名称 |
| -j | boolean | 以 JSON 格式输出 |
| —no-code-check | boolean | 忽略检查源 code 和根目录中的 index 是否存在 |
| —key-v2 | boolean | 使用加密 v2 |
| —package-json | string | 多包项目的 package.json 文件路径(以逗号分隔) |