CLI 入门指南

快速概述

的Capgo CLI提供了一个交互式引导程序，用于为您的Capacitor应用程序设置实时更新。您将：

1. ✅ 在Capgo中注册应用程序
2. 🔌 安装和配置更新插件
3. 🚀 部署您的第一个实时更新
4. 📱 在设备上测试更新

预计时间： 10-20 分钟（根据您的互联网速度和构建时间而异）

提示

整个引导流程都是可恢复的 - 可以随时退出并在之前停止的地方继续。

开始引导流程

使用您的 API 密钥运行引导命令：

npx @capgo/cli@latest init [APIKEY]

您将看到欢迎消息：

Capgo onboarding 🛫

引导流程中的发生

您的 CLI 将指导您完成 13 个交互式步骤：

Setup Phase (Steps 1-6):

• 检查您的开发环境（Xcode/Android Studio）
• 将您的应用程序添加到 Capgo 并创建一个生产频道
• 安装 @capgo/capacitor-updater 插件
• 将所需的 code 注入到您的应用程序中
• 可选：启用端到端加密
• 选择测试平台（iOS 或 Android）

测试阶段 (Steps 7-12):

• 构建应用程序并在设备/模拟器上运行
• 进行可见的 code 变更（自动或手动）
• 将更新的捆绑包上传到 Capgo
• 实时看到设备上的更新

第 13 步：

• 您的应用程序现在可以实时更新了！ 🎉

13 步入门流程

第 1 步：检查先决条件

The CLI checks your development environment to ensure you have the necessary tools installed.

检查的内容：

• Xcode (仅限 macOS) - iOS 开发
• Android SDK - for Android 开发

可能的结果：

✅ 找到两个环境：

✅ Xcode detected - iOS development ready
✅ Android SDK detected - Android development ready

⚠️ 未找到环境：

⚠️ Xcode not found
⚠️ Android SDK not found
❌ No development environment detected

📱 To develop mobile apps with Capacitor, you need:
   • For iOS: Xcode (macOS only) - https://developer.apple.com/xcode/
   • For Android: Android Studio - https://developer.android.com/studio

可能会问你的问题：

注意

如果未检测到开发环境，你会被询问是否继续。建议在继续之前安装至少一个平台。

步骤 2：添加您的应用

The CLI will log you into Capgo and add your app to your account.

(spinner) Running: npm @capgo/cli@latest login ***
Login Done ✅

❓ Add {appId} in Capgo?

如果您的应用程序 ID 已经被占用：

将建议替代方案：CLI

❌ App ID "com.example.app" is already taken
💡 Here are some suggestions:
   1. com.example.app2
   2. com.example.app3
   3. com.example.app.new
   4. com.example.app.app

❓ What would you like to do?

您可以选择建议的替代方案或输入自定义应用程序 ID。

注意

应用程序 ID 必须遵循反向域名表示法（例如， com.example.myapp)

步骤 3：创建生产渠道

渠道允许您管理不同更新流程的应用程序。

❓ Create default channel production for {appId} in Capgo?

提示

别担心！ 这只是用于本地测试，用于新用户的入门过程。创建一个“生产”频道并不是意味着你的更新会立即发布给客户。 你完全控制更新的部署时间。 选择 是 除非你有特定的频道要求。

如果你选择是：

(spinner) Running: npm @capgo/cli@latest channel add production {appId} --default
Channel add Done ✅  (or "Channel already added ✅")

将创建一个生产频道并设置为默认频道。这是大多数用户的推荐选项。

如果你选择否：

If you change your mind, run it for yourself with: "npm @capgo/cli@latest channel add production {appId} --default"

您需要手动创建和配置频道后期。 alternatively，您可以：

• 在您的 capacitor.config.ts 文件
• 使用JavaScript setChannel() 方法动态设置频道
• 稍后从Capgo web控制台配置频道

步骤 4：安装更新插件

CLI 将安装与您的CLI版本兼容的 @capgo/capacitor-updater plugin compatible with your Capacitor version.

❓ Automatic Install "@capgo/capacitor-updater" dependency in {appId}?

步骤 4：安装更新插件

• Capacitor 5: 安装 @capgo/capacitor-updater v5
• Capacitor 6: 安装 @capgo/capacitor-updater v6
• Capacitor 7: 安装 @capgo/capacitor-updater v7
• Capacitor 8+: 安装最新版本

注意

Capgo仅支持Capacitor v5及以上版本。如果您正在使用较旧的版本，需要先升级。

即时更新选项：

安装后，您将被询问：

❓ Do you want to set instant updates in {appId}?
   Read more: https://capgo.app/docs/live-updates/update-behavior/#applying-updates-immediately

提示

什么是即时更新？ 启用即时更新后，应用程序会立即在后台和重新打开时应用更新。这可以无缝工作，因为Capgo可以在全球范围内在300ms内分发更新。没有它（标准模式），更新将在后台下载并在下一次应用程序重启时应用。即时更新对于开发期间的快速迭代和生产环境中的关键bug修复非常有用。

如果您选择是：

• 更新将配置为在应用程序后台和重新打开时立即应用
• directUpdate: 'always' 和 autoSplashscreen: true 将被添加到您的配置中
• 您的 capacitor.config.ts 将自动更新
• Delta 更新 将自动启用 - 这样只会发送更新期间发生的文件变化，而不是完整的捆绑包，这样更新速度会大大提高

如果您选择否：

• 更新将使用标准行为（在后台下载，下次重启时应用）
• 您可以随时通过修改您的 capacitor.config.ts

步骤 5：添加集成 Code

The CLI will automatically inject the required code into your main application file.

❓ Automatic Add "CapacitorUpdater.notifyAppReady()" code and import in {appId}?

What gets added:

import { CapacitorUpdater } from '@capgo/capacitor-updater'

CapacitorUpdater.notifyAppReady()

项目类型检测:

• Nuxt.js: 创建 plugins/capacitorUpdater.client.ts
• 其他框架: 添加到主入口文件

提示

如果自动注入失败,您可以手动将 code 添加到主应用文件中:

对于 Nuxt.js: 创建 plugins/capacitorUpdater.client.ts:

import { CapacitorUpdater } from '@capgo/capacitor-updater'

export default defineNuxtPlugin(() => {
  CapacitorUpdater.notifyAppReady()
})

其他框架： 将其添加到主入口文件（例如 main.ts, index.js, App.tsx):

import { CapacitorUpdater } from '@capgo/capacitor-updater'

CapacitorUpdater.notifyAppReady()

在导入之后，应用初始化之前，将此 code 放在这里。有关更多详细信息，请参阅 添加应用指南.

第 6 步：设置加密（可选）

端到端加密为您的更新添加了额外的安全层。

🔐 End-to-end encryption
   ✅ Use this for: Banking, healthcare, or apps with legal encryption requirements
   ⚠️  Note: Makes debugging harder - skip if you don't need it

❓ Enable end-to-end encryption for {appId} updates?

注意

加密功能仅适用于Capacitor v6及以上版本。

如果您启用加密，CLI将：

1. 生成加密密钥
2. 提供同步Capacitor配置的选项

第 7 步：选择平台

复制到剪贴板

📱 Platform selection for onboarding
   This is just for testing during onboarding - your app will work on all platforms

❓ Which platform do you want to test with during this onboarding?
   Options:
   - iOS
   - Android

这仅影响新手指南过程。您的最终应用程序将支持所有平台。

第 7 步：选择平台

步骤 8: 构建您的项目

CLI 将构建您的应用并同步它与 Capacitor。

❓ Automatic build {appId} with "npm run build"?

发生什么:

1. 检测您的项目类型
2. 运行您的构建脚本
3. 执行 npx cap sync {platform}

如果缺少构建脚本:

您将被询问是否要跳过构建或为您的项目添加一个构建脚本 package.json.

步骤 9: 在设备上运行

在设备或模拟器上测试您的应用的初始版本。

❓ Run {appId} on {PLATFORM} device now to test the initial version?

如果您选择 是:

(spinner) Running: npx cap run {platform}
(device picker appears)
App started ✅
📱 Your app should now be running on your {platform} device with Capgo integrated
🔄 This is your baseline version - we'll create an update next

第 10 步：进行测试更改

现在是时候测试 Capgo 的更新系统了，通过进行一个可见的更改。

🎯 Now let's test Capgo by making a visible change and deploying an update!

❓ How would you like to test the update?
   Options:
   - Auto: Let Capgo CLI make a visible change for you
   - Manual: I'll make changes myself

自动模式： The CLI will automatically modify your files to add a visible test banner or change.

手动模式： 您可以自行修改（例如修改文本、颜色或添加元素）。

版本管理：

❓ How do you want to handle the version for this update?
   Options:
   - Auto: Bump patch version ({currentVersion} → {nextVersion})
   - Manual: I'll provide the version number

使用修改内容构建：

❓ Build {appId} with changes before uploading?

提示

如果您需要在另一个终端手动构建，请选择“否”，然后自己构建，接着继续。

步骤 11：上传打包文件

将您的更新后的应用程序打包文件上传到 Capgo。

❓ Upload the updated {appId} bundle (v{version}) to Capgo?

The CLI 运行:

npx @capgo/cli@latest bundle upload

提示

使用直接更新（Delta 更新）: 如果您在步骤 4 中启用了即时更新（直接更新），则 CLI 将自动询问是否启用 delta 更新。Delta 更新仅发送版本之间变化的文件，而不是整个捆绑包。由于通常只有少数文件在更新之间发生变化，因此这使得下载速度大大提高。选择 是 为即时更新提供最佳体验。

如果直接更新启用，则显示 delta 更新提示:

💡 Direct Update (instant updates) is enabled in your config
   Delta updates send only changed files instead of the full bundle

❓ Enable delta updates for this upload? (Recommended with Direct Update)

注意

对于单元仓库，您可能需要提供额外的路径给 package.json 和 node_modules.

成功：

✅ Update v{version} uploaded successfully!
🎉 Your updated bundle is now available on Capgo

步骤 12：在设备上测试更新

看看更新的效果!

🧪 Time to test the Capgo update system!
📱 Go to your device where the app is running

实时更新：

🔄 IMPORTANT: Background your app (swipe up/press home button) and then reopen it
⏱️  The update should be downloaded and applied automatically

标准更新：

📱 With standard updates, you will need to:
   1. Background the app (swipe up/press home button) to start download
   2. Wait a few seconds for download to complete
   3. Background and foreground again to see the update

监控日志：

❓ Monitor Capgo logs to verify the update worked?

如果您选择 是您将看到设备的实时日志，显示更新过程。

第 13 步：完成

Welcome onboard ✈️!

Congratulations! You’ve successfully set up Capgo live updates for your app.

标题：您已经完成了什么

完成入门后，你有：

✅ 应用程序已注册

您的应用程序已在Capgo中注册，生产频道

✅ 插件已安装

Capacitor更新器插件已安装并配置

✅ Code已集成

已将code集成到您的应用程序中

✅ 更新已测试

您已成功部署并接收到实时更新

日常工作流

对于后续更新，请使用：

npm run build
npx @capgo/cli@latest bundle upload --channel=production

更多部署选项，请参见 部署实时更新.

恢复入门

如果您退出入门过程，可以随时恢复：

npx @capgo/cli@latest init [APIKEY]

您会看到：

You have already got to the step {stepNumber}/13 in the previous session
❓ Would you like to continue from where you left off?

提示

进度会被保存在本地，所以你可以安全地退出并恢复入门流程。

故障排除

没有开发环境

问题： 未检测到 Xcode 或 Android SDK。

解决方案：

• 对于 iOS: 安装 Xcode （macOS only）
• 为 Android: 安装 Android Studio

App ID 已经被占用

问题： 您的应用 ID 已经注册过了。

解决方案： 选择一个建议的替代方案或在反向域名表示法中输入一个自定义应用 ID。

构建脚本丢失

问题： 未找到构建脚本在 package.json.

解决方案： 在你的 package.json:

{
  "scripts": {
    "build": "your-build-command"
  }
}

自动注入失败

问题： CLI无法自动注入code

解决方案： 手动将code添加到你的主文件中：

import { CapacitorUpdater } from '@capgo/capacitor-updater'

CapacitorUpdater.notifyAppReady()

Capacitor 版本过低

问题： 您的 Capacitor 版本低于 v5。

解决方案： 升级 Capacitor 至 v5 或更高版本：

• 升级到 Capacitor 5
• 升级到 Capacitor 6
• 升级到 Capacitor 7

下一步

现在您已经完成了入门，探索这些主题：

发布更新

Capgo控制台中学习如何发布更新

更新类型

OTA更新类型参考：应用时间、延迟条件、版本阻塞和交付

CI/CD集成

使用CI/CD自动化更新部署

频道

使用频道管理多个更新流

加密

使用端到端加密保护更新

更新行为

自定义更新何时和如何应用（直接、差分等）

获取帮助

如果您在入门过程中遇到问题：

• 检查 故障排除指南
• 加入 Discord 社区
• 查看 常见问题
• 联系 支持