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

このプラグインのインストール手順とフルマークダウンガイドを含む設定プロンプトをコピーする

クイックオーバー

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

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

Estimated time: 10-20 minutes (varies based on your internet speed and build time)

Starting the Onboarding

Run the onboarding command with your API key:

npx @capgo/cli@latest init [APIKEY]

You’ll see the welcome message:

Capgo onboarding 🛫

Onboardingの過程

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

セットアップフェーズ（ステップ1-6）

開発環境（Xcode/Android Studio）を確認する
Capgoにアプリを追加し、生産チャンネルを作成する
__CAPGO_KEEP_0__ @capgo/capacitor-updater プラグイン
codeをアプリにインジェクトする
オプションでエンドツーエンド暗号化を有効にする
テスト用のプラットフォームを選択（iOSまたはAndroid）

テストフェーズ（ステップ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

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

ステップ 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 を入力できます。

Step 3: Production チャンネルを作成

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

❓ 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 の方法で、ダイナミックにチャネルを設定する
__CAPGO_KEEP_0__ ウェブコンソールから後でチャネルを設定する setChannel() ステップ 4: アップデートプラグインをインストールする
Configure channels later from the Capgo web console

__CAPGO_KEEP_0__ はアップデートプラグインをインストールします

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 5v5 @capgo/capacitor-updater __CAPGO_KEEP_0__ 6
Capacitor 8+：最新バージョンをインストール

即時更新オプション：

インストール後、次の質問に答える必要があります。

❓ 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 自動的に更新されます。
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
その他のフレームワーク：メインエントリファイルに追加

自動インジェクションが失敗した場合code を手動でアプリケーションファイルに追加してください。

Nuxt.js の場合: 作成 plugins/capacitorUpdater.client.ts:

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

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

他のフレームワークの場合: __CAPGO_KEEP_0__ をインポートした後、そしてアプリケーションを初期化する前に、主なエントリーファイルに追加してください。 main.ts, index.js, App.tsx):

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

CapacitorUpdater.notifyAppReady()

Place this code after your imports and before your app initialization. For more details, see the ステップ 6:暗号化の設定（オプション）.

ステップ 6:暗号化の設定（オプション）

__CAPGO_KEEP_0__のエンドツーヘンド暗号化は、更新のセキュリティ層を追加します。

🔐 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するオファーする

ステップ 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

Step 8: Build Your Project

CLIはアプリをビルドし、Capacitorと同期します。

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

何が起こるか:

プロジェクトのタイプを検出します
ビルドスクリプトを実行します
実行 npx cap sync {platform}

ビルドスクリプトが存在しない場合:

__CAPGO_KEEP_0__のビルドをスキップするか、ビルドスクリプトをプロジェクトに追加するかを尋ねられます。 package.json.

Step 9: デバイスで実行

アプリの初期バージョンをデバイスまたはシミュレータでテストしてください。

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

あなたが選択した場合 Yes:

(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は自動的にファイルを変更して、テストバナーを表示可能にするか、変更します。

マニュアルモード: 自分で変更を実行します(例えば、テキストや色を変更したり、要素を追加したり)。

バージョンハンドリング:

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

CLIが実行中です。

npx @capgo/cli@latest bundle upload

Delta updates prompt (if an instant apply mode is enabled):

💡 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

For instant updates:

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

For standard updates:

📱 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 logs:

❓ Monitor Capgo logs to verify the update worked?

If you select Yes, you’ll see live logs from your device showing the update process.

Step 13: Completion

Welcome onboard ✈️!

成功しました！あなたのアプリに Capgo ライブ更新が正常に設定されました。

あなたが達成したこと

オンボーディングを完了したあと、次のことが実行されます。

✅ アプリ登録

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

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

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

✅ Code統合

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

✅ アップデートテスト

あなたはライブアップデートを正常にデプロイし、受信しました。

毎日ワークフロー

以降の更新については、以下を使用してください:

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

その他のデプロイオプションについては、以下を参照してください。ライブアップデートをデプロイする.

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

オンボーディングプロセスから退出した場合、いつでも再開できます。

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専用)
Android向け: インストール Android Studio

アプリIDがすでに登録されています

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

解決策: 指定された代替案件の1つを選択するか、逆ドメイン記法でカスタムアプリIDを入力してください。

ビルドスクリプトが見つかりません

問題: No build script found in package.json.

Solution: Add a build script to your package.json:

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

Auto-Injection Failed

__CAPGO_KEEP_0__は、__CAPGO_KEEP_1__の統合を自動的に挿入できません。 CLIはcodeの統合を自動的に挿入できません。

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

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

CapacitorUpdater.notifyAppReady()

Capacitor バージョンが古すぎる

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

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

次のステップ

オンボーディングを完了した後は、これらのトピックを調べることができます:

デプロイの更新

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

更新のタイプ

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

CI/CDの統合

更新のデプロイをCI/CDで自動化する

チャンネル

複数の更新のストリームをチャンネルで管理する

暗号化

__CAPGO_KEEP_0__をエンドツーエンド暗号化で保護

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__をカスタマイズして、更新が適用されるタイミングと方法 (直接、デルタなど) を指定できます

__CAPGO_KEEP_3__

__CAPGO_KEEP_5__の場合:

__CAPGO_KEEP_6__を確認してください __CAPGO_KEEP_7__
__CAPGO_KEEP_8__に参加してください __CAPGO_KEEP_9__を確認してください
__CAPGO_KEEP_10__を確認してください __CAPGO_KEEP_11__を確認してください
お問い合わせサポート

CLI Onboarding ガイドから続けて

__CAPGO_KEEP_0__ を使用している場合 CLI Onboarding ガイド API をダッシュボードと API の運用に計画する場合、API と接続してください。 API の実装詳細については、API オーバービューを参照してください。 API オーバービューの実装詳細については、API オーバービューを参照してください。導入導入の実装詳細については、導入を参照してください。 API キー API キーの実装詳細についてデバイス __CAPGO_KEEP_0__ キーの実装詳細についてデバイス、バンドル __CAPGO_KEEP_0__ キーの実装詳細についてバンドル。