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

インストール手順とこのプラグインの全マークダウンガイドを含むセットアップ用の質問をコピーする

クイックオーバー

CapgoのCapgo CapgoのCLIは、ライブアップデートを設定するためのインタラクティブなオンボーディングを提供します。CapgoのCapacitorアプリケーションで、次のことを行います。

✅ CapgoのCapgoにアプリケーションを登録する
🔌 アップデートプラグインをインストールおよび設定する
🚀 最初のライブアップデートをデプロイする
📱 __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 プラグイン
必要な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: アプリを追加

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

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

❓ Add {appId} in Capgo?

アプリ ID がすでに取られている場合:

Capgo の 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 default channel production for {appId} in Capgo?

Yes:

(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 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+最新バージョンをインストールします

即時更新オプション：

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

❓ 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 config に追加されます
Your capacitor.config.ts 自動的に更新されます
Delta 更新 自動的に有効になります - この機能は、更新間で変更されたファイルのみを送信するため、更新が大幅に高速化されます

No を選択した場合:

更新は標準の動作 (バックグラウンドでダウンロード、再起動後のアプリで適用) を使用します
いつでも、config を変更して即時更新を有効にすることができます capacitor.config.ts

Step 5: Codeを追加する

CLIは、必要なcodeを自動的にアプリケーションファイルにインジェクトします。

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

追加されるもの:

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

CapacitorUpdater.notifyAppReady()

プロジェクトタイプの検出:

ナウツ: 作成 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: .

ステップ 6: オプションで暗号化を設定する

アップデートのセキュリティ層を追加するEnd-to-end encryption

🔐 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を選択する

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

何が起こるか：

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

If build script is missing:

build scriptが見つからない場合: package.json.

Step 9: Run on Device

Section titled “Step 9: Run on Device”

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

Test the initial version of your app on a device or simulator. アプリの初期バージョンをデバイスまたはエミュレータでテストする:

(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

Yes

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?

Step 11: __CAPGO_KEEP_0__をアップロードする

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

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

CLIが実行中:

npx @capgo/cli@latest bundle upload

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)

成功:

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

あなたが「Yes」を選択 、あなたはあなたのデバイスからライブログを表示し、更新プロセスを表示することができます。Step 13: Completion

ステップ 13: 完了のセクションのタイトル

Welcome onboard ✈️!

Capgoのライブアップデートをクリップボードにコピーします

__CAPGO_KEEP_0__のライブアップデートを設定しました。

セクション：実施したこと

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

Your app is registered in Capgo with a production channel

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

The Capacitor Updater plugin is installed and configured

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

✅ codeが統合されました

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

デプロイとライブアップデートを正常に実行しました

毎日のワークフロー

以降のアップデートの場合、使用してください:

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がすでに登録されています。

Solution: Choose one of the suggested alternatives or enter a custom app ID in reverse domain notation.

Build Script Missing

Problem: No build script found in package.json.

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

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

Auto-Injection Failed

Problem: CLI は自動的にインジェクトできません。code のインテグレーションです。

解決策： code を手動でメインファイルに追加してください。

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

CapacitorUpdater.notifyAppReady()

Capacitor のバージョンが古い

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

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

次のステップ

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

ワンタイム設定チェックリスト

チャンネル、CI、デルタアップロードを一度に長期的な安定性のために設定する

デプロイ

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

アップデートの種類

OTAアップデートの種類のすべての参照：適用時期、遅延条件、バージョンブロッキング、配信

CI/CD統合

CI/CDを使用してアップデートのデプロイを自動化する

チャンネル

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

暗号化

アップデートをエンドツーエンド暗号化してセキュリティを確保する

アップデートの動作

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

ヘルプ

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

チェックするトラブルシューティングガイド
参加する Discordコミュニティ
Review the FAQ
Contact サポート

CLI Onboardingガイドから続けて

Capgoを使用している場合 CLI Onboardingガイド ダッシュボードとAPI の運用を計画するには、API Onboardingガイドを API オーバービュー Capgoオーバービューの実装詳細については、API オーバービューを参照してください。 Introduction Introductionの実装詳細について API Keys API Keysの実装詳細について Devices Devicesの実装詳細について Bundles Bundlesの実装詳細について