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

クイックオーバービュー

CapgoのCLIは、ライブアップデートの設定を含むインタラクティブなオンボーディングを提供します。Capacitorアプリの場合、次のことが行われます。

1. ✅ Capgoにアプリを登録する
2. 🔌 アップデートプラグインをインストールおよび設定する
3. 🚀 最初のライブアップデートをデプロイする
4. 📱 __CAPGO_KEEP_0__ をデバイスでテストしてください

Estimated time: 10-20 分 (インターネット接続速度とビルド時間に応じて変わります)

ヒント

オンボーディングは完全に再開可能です - いつでも中断して、途中から再開できます。

オンボーディングの開始

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

npx @capgo/cli@latest init [APIKEY]

ウェルカムメッセージが表示されます:

Capgo onboarding 🛫

オンボードプロセスの流れ

CLIは、13ステップのインタラクティブなガイドを提供します。

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

• 開発環境 (Xcode/Android Studio) を確認する
• Capgoにアプリを追加し、生産チャンネルを作成する
• __CAPGO_KEEP_0__プラグイン @capgo/capacitor-updater __CAPGO_KEEP_0__をアプリにインジェクトする
• Inject the required code into your app
• テスト用のプラットフォームを選択 (iOS または Android)
• __CAPGO_KEEP_0__

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

• アプリをビルドし、デバイス/エミュレータで実行する
• code の可視的な変更 (自動または手動) を行う
• Capgo への更新されたパッケージをアップロードする
• 実時間でデバイス上でライブ更新を確認する

完了 (ステップ 13):

• アプリはライブ更新に準備できました! 🎉

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

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

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

何がチェックされています：

• Xcode (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

質問されるかもしれません：

注意

開発環境が検出されない場合は、続行する場合は質問されます。少なくとも 1 つのプラットフォームをインストールすることをお勧めします。

Step 2: アプリを追加

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

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

注意

App IDは逆ドメイン記法でなければなりません (例えば、 com.example.myapp)

Step 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 ✅")

生産用のチャンネルが作成され、デフォルトに設定されます。このオプションは、ほとんどのユーザーにとって推奨されるオプションです。

No を選択した場合:

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 plugin compatible with your Capacitor version.

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

バージョン互換性：

• 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以内に更新を配布できるため、背景化されたアプリと再起動されたアプリで即時更新が可能になります。標準モードでは、更新はバックグラウンドでダウンロードされ、再起動後のアプリで適用されます。即時更新は開発中の高速な反復と生産環境での重要なバグ修正に適しています。

Yesを選択すると:

• アプリが背景化されたときと再起動されたときに即時更新が適用されるようになります
• autoUpdate: 'always' そして autoSplashscreen: true あなたの設定に追加されます
• あなたの capacitor.config.ts 自動的に更新されます
• Delta更新 変更されたファイルのみを送信するため、更新が大幅に高速化されます。

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
• その他のフレームワーク: メインエントリファイルに追加

Tip

自動インジェクションが失敗した場合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:オプションの暗号化設定を参照してください。 ステップ6:オプションの暗号化設定.

ステップ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: プラットフォームの選択

Choose which platform to test with during onboarding.

📱 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: テスト変更」セクション

Now it’s time to test Capgo’s update system by making a visible change.

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

ヒント

必要に応じて別のターミナルで手動でビルドする場合は、「No」を選択し、自分でビルドし、続行してください。

ステップ11：バンドルアップロード

Capgoにアップデートしたアプリケーションバンドルをアップロードしてください。

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

CLIが実行中です。

npx @capgo/cli@latest bundle upload

ヒント

デルタアップデートと即時更新: ステップ4で即時更新を有効にした場合、CLIは自動的にデルタアップデートを有効にするかどうか尋ねます。デルタアップデートは、バージョン間で変更されたファイルのみを送信するのではなく、全体のバンドルを送信します。通常、更新間で変更されるのはファイルが少数だけなので、ダウンロードがはるかに速くなります。選択 はい 最良の体験を得るには、即時更新をご利用ください。

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

あなたが「はい」を選択 あなたが「はい」を選択した場合、Step 13: 完了

「Step 13: 完了」セクションのタイトル

Welcome onboard ✈️!

Capgoのライブ更新をアプリに成功させました。

達成したこと

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

✅ アプリ登録

Capgoにプロダクションチャンネルでアプリが登録されています。

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

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

✅ Code統合

codeの統合がアプリに追加されています。

✅ アップデートテスト

You’ve successfully deployed and received a live update

日々のワークフロー

以降の更新の場合、使用してください：

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のみ)
• Android向け: インストール 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、デルタアップロードを一度設定して長期的な安定性を確保する

デプロイ更新

Capgo ダッシュボードから更新をデプロイする方法を学びます

更新タイプ

OTA更新の種類のすべてのリファレンス：適用タイミング、遅延条件、バージョンブロッキング、配信

CI/CD統合

CI/CDを使用して更新のデプロイを自動化する

チャンネル

複数のアップデート ストリームを管理する

暗号化

アップデートをエンドツーエンド暗号化で保護する

アップデートの動作

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

ヘルプ

初期設定中に問題が発生した場合:

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

CLI オンボーディング ガイドから続けて

「__CAPGO_KEEP_0__ オンボーディング ガイド」を使用している場合 「CLI オンボーディング ガイド」 ダッシュボードと「API オンボーディング ガイド」オペレーションを計画するには 「API オーバーヴィュー」 「API オーバーヴィュー」の実装詳細について 導入 導入の実装詳細について API キー API キーの実装詳細について デバイス デバイスの実装詳細について バンドル バンドルの実装詳細について