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

このプラグインのインストール手順とフルマークダウンガイドを含むセットアッププロンプトをコピーします。

クイックオーバー

Capgo CLIは、ライブアップデートを設定するためのインタラクティブなオンボーディングを提供します。Capacitorアプリのために、以下のことが行われます:

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

推定所要時間: 10-20分 (インターネット速度とビルド時間に応じて変わります)

オンボーディングの開始

API キーとともにオンボーディングコマンドを実行する

npx @capgo/cli@latest init [APIKEY]

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

Capgo onboarding 🛫

オンボーディングの流れ

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

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

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

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

アプリをビルドし、デバイス/エミュレータで実行
自動または手動で code に表示される変更を実行
更新されたパッケージを Capgo にアップロード
実際のリアルタイムでデバイス上で更新を確認

完了 (ステップ 13):

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

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

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

The CLI checks your development environment to ensure you have the necessary tools installed.

What's checked:

Xcode (macOS only) - iOS開発用
Android SDK - Android開発用

Possible outcomes:

✅ 両方の環境が見つかった:

✅ 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 を入力したりできます。

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

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

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_KEEP_0__ Webコンソールからチャンネルを設定します。
Configure channels later from the Capgo web console

ステップ 4: アップデートプラグインをインストールする

CapgoはCLIのバージョンに適合したプラグインをインストールします。 @capgo/capacitor-updater plugin compatible with your Capacitor version.

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

__CAPGO_KEEP_0__ 5

Capacitor 5__CAPGO_KEEP_0__ 6 @capgo/capacitor-updater Capgo 6
Capacitor 6v5 @capgo/capacitor-updater インストール
Capacitor 7: @capgo/capacitor-updater v7
Capacitor 8+:

Instant updates option:

After installation, you’ll be asked:

❓ 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 に追加されます。
あなたの capacitor.config.ts 自動的に更新されます。
Delta アップデート 自動的に有効になります - この機能は、更新の間で変更されたファイルのみを送信し、フルバンドルの代わりに、更新が速くなります。

No を選択した場合:

アップデートは標準の動作を使用します (バックグラウンドでダウンロード、再起動後に適用)
いつでも、インスタントアップデートを有効にするには、設定を変更することができます 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?

CLI を有効にすると、CLI は以下のことを行います:

__CAPGO_KEEP_0__ の暗号化キーを生成
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

Step 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

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

今は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

__CAPGO_KEEP_0__モード: CLIは、可視的なテストバナーを追加するか変更するために、自動的にファイルを変更します。

__CAPGO_KEEP_0__モード: 自分で変更を実行します(例えば、テキスト、色、または要素を追加します)。

バージョン管理:

❓ 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 更新のプロンプト (即時適用モードが有効の場合):

💡 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

Step 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の統合が追加されました。

✅ テスト済みの更新

アプリを正常にデプロイし、ライブ更新を受け取ったことが確認されました。

日々のワークフロー

以降の更新については、以下の手順に従ってください。

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

解決策: 提案された代替の1つを選択するか、逆ドメイン記法でカスタムアプリ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 またはそれ以上のバージョンにアップグレードしてください:

次のステップ

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

一度の設定チェックリスト

長期の安定性のために、チャンネル、CI、デルタアップロードを一度に設定してください

デプロイ

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

アップデートの種類

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

CI/CD統合

CI/CDを使用して自動的にアップデートのデプロイを実行

チャンネル

Capgoのリリースチャンネル機能名

マルチアップデートストリームを管理する

暗号化

アップデートを暗号化してセキュリティを確保

アップデートの動作

アップデートの適用時期と方法をカスタマイズ

トラブルシューティング

問題が発生した場合に確認するトラブルシューティングガイド
参加するディスコードコミュニティ
レビュー FAQ
連絡サポート

Keep going from CLI Onboarding Guide

使用している場合 CLI オンボーディングガイド API オンボーディングガイド API オーバービュー API オーバービューの実装詳細のため導入導入の実装詳細のため API キー API キーの実装詳細のためデバイスデバイスの実装詳細のため、バンドルバンドルに関する実装詳細のため。

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

クイックオーバー

オンボーディングの開始

オンボーディングの流れ

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

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

ステップ 2: アプリを追加

ステップ 3: 生産用チャンネルを作成する

ステップ 4: アップデート プラグインをインストールする

ステップ 5: インテグレーションを追加 Code

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

ステップ 7:プラットフォームの選択

Step 8: プロジェクトのビルド

ステップ 9: デバイスで実行

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

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

Step 12: デバイスでアップデートをテストする

Step 13: Completion

あなたが達成したこと

日々のワークフロー

オンボーディングを再開

トラブルシューティング

開発環境が存在しません

アプリIDがすでに取られています。

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

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

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

次のステップ

アップデートの適用時期と方法をカスタマイズ

Keep going from CLI Onboarding Guide

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

ステップ 4: アップデートプラグインをインストールする