CLI オンボーディングガイド

このプラグインのインストールステップとフルマークダウンガイドのセットアッププロンプトをコピーする

クイックオーバー

CapgoのCLIは、Capacitorアプリのライブアップデートの設定に役立つインタラクティブなオンボーディングを提供します。

✅ Capgoにアプリを登録する
🔌 アップデートプラグインのインストールと設定
🚀 最初のライブアップデートをデプロイする
📱 デバイス上でアップデートをテストする

予想時間: 10-20分 (インターネット接続速度とビルド時間に基づいて変わります)

オンボーディングを開始する

API キーとともにオンボーディングコマンドを実行してください:

npx @capgo/cli@latest init [APIKEY]

ようこそメッセージが表示されます:

Capgo onboarding 🛫

オンボーディング中のこと

The CLI will guide you through 13 interactive steps:

セットアップフェーズ (ステップ 1-6):

開発環境を確認 (Xcode/Android Studio)
アプリをCapgoに追加し、生産チャネルを作成
__CAPGO_KEEP_1__をインストール @capgo/capacitor-updater プラグイン
Inject the required code into your app
オプションでエンドツーエンド暗号化を有効
テスト用プラットフォームを選択 (iOS または Android)

テストフェーズ (ステップ 7-12):

アプリをビルドし、デバイス/シミュレータで実行
codeの可視化された変更を行う (自動または手動)
アップデートされたバンドルをCapgoにアップロードしてください
実時間でデバイス上でライブ更新を確認できます

完了 (ステップ 13):

あなたのアプリはライブ更新に準備できました！ 🎉

13ステップのオンボーディングプロセス

ステップ 1: 必要な前提条件を確認する

CLIはあなたの開発環境をチェックし、必要なツールがインストールされていることを確認します。

チェックされるもの:

Xcode (macOSのみ) - iOS開発用
Android SDK - アンドロイド開発用

可能な結果:

✅ 両方の環境が見つかりました:

✅ 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: アプリを追加する

CLIはCapgoにログインし、CLIをアカウントに追加します。

(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を入力できます。

Step 3: Create Production Channelのステップ

チャンネルは、管理用の異なるアップデートストリームをアプリに提供します。

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

後でチャンネルを作成して設定する必要があります。代わりに、

チャンネルを capacitor.config.ts ファイル
でチャンネルを動的に設定する setChannel() 後で
Configure channels later from the Capgo web console

Step 4: Updater プラグインをインストールする

CLI @capgo/capacitor-updater Capacitor

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

バージョン互換性:

Capacitor 5v5 @capgo/capacitor-updater __CAPGO_KEEP_0__ 6
Capacitor 6__CAPGO_KEEP_0__ 7 @capgo/capacitor-updater v7
Capacitor 8+最新バージョンをインストールします. @capgo/capacitor-updater v5
Capacitor 6v6

即時更新オプション:

インストール後、次の質問が行われます:

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

Yesを選択した場合:

更新はアプリがバックグラウンドで再起動されたときに即時適用されます。
autoUpdate: 'always' そして autoSplashscreen: true あなたの設定に追加されます
あなたの capacitor.config.ts 自動的に更新されます
デルタ更新 自動的に有効になります - これは、更新の間の変更されたファイルのみを送信するため、更新がはるかに速くなります

あなたが「No」を選択した場合:

更新は標準の動作を使用します (バックグラウンドでダウンロード、次の再起動時に適用)
あなたはいつでも、あなたの capacitor.config.ts

Step 5: Add Integration 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 を手動で追加してください

For Nuxt.js: 作成 plugins/capacitorUpdater.client.ts:

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

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

For other frameworks: Add to your main entry file (e.g., main.ts, index.js, App.tsx):

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

CapacitorUpdater.notifyAppReady()

codeをインポートした後、そしてアプリケーションを初期化する前に追加してください。詳細は、 Add an App guide.

Step 6: Setup Encryption (Optional)

End-to-end encryption adds an extra security layer for your updates.

🔐 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?

暗号化を有効にすると、CLI は以下の機能を提供します。

暗号化キーを生成する
Capacitor の構成をsyncするように提案する

Step 7: Platformを選択

初回設定の際にテストするプラットフォームを選択する

📱 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"?

何が起こるか:

プロジェクトのタイプを検出する
ビルドスクリプトを実行する
実行 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

Step 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は、可視的なテストバナーを追加するか変更するために、自動的にあなたのファイルを修正します。

Manual mode: You make your own changes (e.g., change text, colors, or add elements).

Version handling:

❓ 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 with changes:

❓ Build {appId} with changes before uploading?

Step 11: Upload Bundle

Upload your updated app bundle to Capgo.

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

CLIが実行中です。

npx @capgo/cli@latest bundle upload

デルタ更新の求められ方(即時適用モードが有効の場合):

💡 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)

成功:

✅ 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?

あなたが選択した場合はい,

Step 13: Completion

Welcome onboard ✈️!

Capgoのライブアップデートをアプリに成功させました。

あなたが達成したこと

オンボーディングを完了すると、以下のことが実行されます。

✅ アプリケーション登録

あなたのアプリケーションは、Capgo にプロダクションチャネルで登録されています。

✅ プラグインのインストール

Capacitor アップデートプラグインがインストールされ、設定されています。

✅ Code の統合

code の統合があなたのアプリケーションに追加されています。

✅ アップデートのテスト

あなたは、実際のアップデートをデプロイし、受信することができました。

Daily Workflow

For subsequent updates, use:

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

For more deployment options, see Deploy a Live Update.

Resuming Onboarding

If you exit the onboarding process, you can resume anytime:

npx @capgo/cli@latest init [APIKEY]

You’ll see:

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)
For Android: Install Android Studio

App ID Already Taken

Problem: あなたのアプリIDはすでに登録されています。

Solution: 提案されたオプションのいずれかを選択するか、逆ドメイン記法でカスタムアプリIDを入力してください。

Build Script Missing

問題: __CAPGO_KEEP_0__で検索 package.json.

解決策: __CAPGO_KEEP_0__にビルドスクリプトを追加してください package.json:

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

自動インジェクション失敗

問題: CLIは、自動的にcodeをインジェクションできません。

解決策: codeを手動でcodeの主ファイルに追加してください

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

CapacitorUpdater.notifyAppReady()

Capacitor のバージョンが古すぎます

問題: Capacitor のバージョンが v5 未満です

解決策: Capacitor を v5 またはそれ以上のバージョンにアップグレードしてください

次のステップ

Now that you’ve completed onboarding, explore these topics:

Deploy Updates

Learn how to deploy updates from the Capgo dashboard

Update Types

Reference of all OTA update types: apply timing, delay conditions, version blocking, and delivery

CI/CD Integration

Automate your update deployments with CI/CD

Channels

Manage multiple update streams with channels

Encryption

Secure your updates with end-to-end encryption

Update Behavior

アップデートの適用時期と方法をカスタマイズ (直接、デルタなど)

ヘルプを取得する

オンボーディング中に問題が発生した場合:

確認するトラブルシューティングガイド
Discord コミュニティに参加する FAQ を確認する
サポートに連絡する __CAPGO_KEEP_0__
__CAPGO_KEEP_0__ __CAPGO_KEEP_0__

続けてください: CLI オンボーディングガイド

あなたが「__CAPGO_KEEP_0__ オンボーディングガイド」を使用している場合 CLI オンボーディングガイド API オンボーディングガイドダッシュボードとAPI の運用を計画する場合に接続するには、実装の詳細については「API オーバービュー」実装の詳細については「__CAPGO_KEEP_0__ オーバービュー」「__CAPGO_KEEP_0__ キー」実装の詳細については「API キー」 for the implementation detail in API Keys, 実装の詳細については「デバイス」 __CAPGO_KEEP_0__の実装詳細についての情報は、デバイスのページで見つけることができます。 __CAPGO_KEEP_0__の実装詳細についての情報は、__CAPGO_KEEP_0__のページで見つけることができます。 __CAPGO_KEEP_0__のページを編集