CLI 入门指南

快速概述

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

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

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

提示

整个入门过程都是可恢复的 - 退出任何时候，稍后从您离开的地方继续。

开始入门

使用您的API密钥运行入门命令：

npx @capgo/cli@latest init [APIKEY]

您将看到欢迎消息：

Capgo onboarding 🛫

什么是入门流程

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

设置阶段（步骤 1-6）：

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

测试阶段（第 7-12 步）：

• 构建并在设备/模拟器上运行您的应用
• 在设备上显示一个可见的code变化（自动或手动）
• 将更新的捆绑包上传到Capgo
• 在设备上实时看到live update

完成（第 13 步）：

• 您的应用已准备好进行实时更新！ 🎉

13 步入门流程

步骤 1：检查前置条件

CLI检查您的开发环境以确保您已安装必要的工具。

什么会被检查：

• Xcode (macOS only) - 仅限macOS，用于iOS开发
• Android SDK - 仅限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 已经被占用：

The CLI will suggest alternatives:

❌ 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。

注意

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

步骤 3：创建生产渠道

是

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

复制到剪贴板

提示 别担心！ Yes 步骤 3：创建生产渠道

如果您选择是：

(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"

您需要手动创建和配置频道。或者，您可以:

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

步骤 4: 安装更新插件

The CLI will install the @capgo/capacitor-updater 插件与您的Capacitor版本兼容。

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

v5

• Capacitor 5v6 @capgo/capacitor-updater v5
• Capacitor 6v6 @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 修复非常有用。

如果您选择是:

• 更新将配置为在应用程序后台和重新打开时立即应用
• autoUpdate: 'always' 并且 autoSplashscreen: true 将添加到您的配置
• @capacitor/splash-screen 将安装，如果缺失， launchAutoHide: false
• 您的 capacitor.config.ts 将自动更新
• 差分更新 保持启用。即刻应用（always, atInstall, onLaunch）应继续使用 npx @capgo/cli@latest bundle upload --delta 所以只有改变的文件下载，用户不会等待一个完整的zip

如果您选择否：

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

第 5 步：添加集成 Code

集成 CLI 将自动将所需的 code 注入您的主应用程序文件中。

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

添加什么：

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

提示

仅影响引导程序过程。您的最终应用将支持所有平台。

第 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

自动模式： CLI会自动修改您的文件，添加可见的测试横幅或更改。

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

版本处理：

❓ 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：上传包

Upload your updated app bundle to Capgo.

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

将您的更新后的应用程序包上传到 CLI。

npx @capgo/cli@latest bundle upload

提示

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

为即时更新提供最佳体验。

💡 Instant updates are enabled in your config
   Delta updates send only changed files instead of the full bundle

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

复制到剪贴板

注意 package.json and node_modules.

Success:

✅ 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 ✈️!

恭喜！您成功地为应用程序设置了Capgo实时更新。

您已经完成的内容

完成入门后，您有：

✅应用程序已注册

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

✅插件已安装

Capacitor

Code

code

✅ __CAPGO_KEEP_0__

✅ live update

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__ Live Update.

恢复入门流程

如果您退出入门流程，可以随时恢复:

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)
• 对于 Android: 安装 安卓 studio

应用 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

下一步

现在您已经完成了入门流程，了解这些主题：

一次性设置清单

配置通道、CI和delta上传一次，长期稳定

部署更新

了解如何从 Capgo 控制台部署更新

更新类型

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

CI/CD集成

在CI/CD中自动化您的更新部署

频道

管理多个更新流程

加密

以端到端加密方式保护您的更新

更新行为

自定义更新的应用时间和方式（直接、差分等）

获取帮助

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

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

继续从CLI入门指南

如果您正在使用 CLI 入门指南 为计划仪表板和API操作，连接它 API概览 了解API概览的实施细节 简介 了解简介的实施细节 API密钥 了解API密钥的实施细节 设备 设备 包 了解包的实施细节