コンテンツにスキップ
Capgo - Capacitor アプリのライブ更新 Capgo

コマンド

使用方法

「使用方法」のセクション

すべてのコマンドは、capacitor プロジェクトが正しく始動されているアプリ フォルダ内で実行する必要があります。

Capacitor Web アプリ向けクロス プラットフォーム ネイティブ ランタイム

初期化

「初期化」のセクション

npx @capgo/cli@latest init [apikey]

このメソッドは、ステップごとにあなたを導きます。

Capgo にアプリを追加します。 code をアプリに追加して、更新を検証します。同様に、ビルドを実行し、Capgo にアプリをアップロードし、更新が正常に動作するかどうかを確認します。

ログイン

セクション「ログイン」

npx @capgo/cli login [apikey]

このメソッドはあなたの apikey を覚えておくためにあります。

オプションで次の値を指定できます:

--local この設定はあなたの APIキー をローカルリポジトリに保存し、gitで無視します。

医者

医者セクション

npx @capgo/cli doctor

Capgo パッケージと最新の状態かどうかを確認するコマンドです。

このコマンドは、バグレポートの際にも役立ちます。

アプリ

アプリセクション

追加

追加セクション

npx @capgo/cli app add [appId]

[appId] アプリIDのフォーマットはこちらで説明しています。 com.test.app ここでは、すべてのオプションが自動的に推測されます。configファイルに指定されていない場合。 💡.

アプリIDを追加してください。

任意に、以下の情報を指定することができます:

  • --icon [/path/to/my/icon] Capgo ウェブアプリにカスタムアイコンを表示するために:
  • --name [test] __CAPGO_KEEP_0__ リスト内のカスタム名を指定するために:
  • --apikey [key] API キーを使用して、自分のアカウントにリンクするために:
  • --retention [retention] アプリパッケージの保持期間（日数）、0（デフォルト）= 無限:

例: capacitor.config.json appId と AppName の場合、アイコンはリソースフォルダ内の guess によって決定されます。

{
  "appId": "ee.forgr.capacitor_go",
  "appName": "Capgo",
  "webDir": "dist"
}

設定

「設定」タイトルのセクション

npx @capgo/cli app set [appId]

[appId] あなたのアプリIDです。形式はここで説明されています。 ここ.

Optionally, you can give:

  • --icon [/path/to/my/icon] Capgoのアイコンをカスタマイズしたい場合は、
  • --name [test] __CAPGO_KEEP_0__のリスト名をカスタマイズしたい場合は、
  • --retention [retention] アプリパッケージの保存期間（日数）、0を指定すると無限
  • --apikey [key] APIキーを使用してアカウントにリンクする

リスト

リストのタイトル

npx @capgo/cli app list [appId]

[appId] アプリIDのフォーマットは com.test.app ここで説明しています __CAPGO_KEEP_0__のアイコンをカスタマイズしたい場合は、.

__CAPGO_KEEP_0__キーを使用してアカウントにリンクする.

  • --apikey [key] API key to link to your account.

削除

セクション：削除

npx @capgo/cli app delete [appId]

[appId] アプリIDの形式は com.test.app 説明は ここ.

オプションで、__CAPGO_KEEP_0__キーを指定してアカウントにリンクできます。

  • --apikey [key] API key to link to your account.
  • --bundle デバッグ

セクション：デバッグ

アプリIDの形式は

npx @capgo/cli app debug [appId]

[appId] 説明は com.test.app ここ ここ.

Optionally, you can give:

  • --apikey [key] API key を使用してアカウントにリンクします。
  • --device 特定のデバイスでデバッグする

設定

セクションのタイトルは “設定”

npx @capgo/cli app setting [path]

Capacitor config を編集します。

[path] - 変更したい設定のパス。例えば、自動更新を無効にする場合は appId提供 appId. 自動更新を無効にする場合は capacitor-updater提供 plugins.CapacitorUpdater.autoUpdate with --string off.

必ず __CAPGO_KEEP_0__ を提供する必要があります。 --string または --bool!

オプション:

  • --string <string> - __CAPGO_KEEP_0__ を文字列に設定します。
  • --bool <true | false> - __CAPGO_KEEP_0__ をブール値に設定します。

バンドル

「バンドル」名のセクション

アップロード

「アップロード」名のセクション

npx @capgo/cli bundle upload [appId]

[appId] アプリケーションIDです。形式についてはこちらを参照してください。 オプションで指定する場合は、.

__CAPGO_KEEP_0__

  • --apikey <apikey> API をクリックしてアカウントにリンクします。
  • --path <path> アップロードするフォルダのパス。
  • --channel <channel> リンク先のチャンネル。
  • --external <url> Capgo Cloud にアップロードするのではなく、外部 URL にリンクします。
  • --iv-session-key <key> バンドル URL の外部オプションの場合の IV とセッション キーを設定します。
  • --s3-endpoint <s3Endpoint> S3 エンドポイントの URL。デルタ アップロードや外部オプションは機能しません。
  • --s3-region <region> S3 バケットのリージョン。
  • --s3-apikey <apikey> S3 エンドポイントの API キー。
  • --s3-apisecret <apisecret> S3 エンドポイントの API シークレット。
  • --s3-bucket-name <bucketName> AWS S3 バケットの名前。
  • --s3-port <port> S3 エンドポイントのポート。
  • --no-s3-ssl S3 アップロードの SSL を無効にします。
  • --key <key> カスタムパスフォーポブリックシグニングキー(v1システム).
  • --key-data <keyData> パブリックシグニングキー(v1システム).
  • --key-v2 <key> カスタムパスフォーピリバートシグニングキー(v2システム).
  • --key-data-v2 <keyData> プライベートシグニングキー(v2システム).
  • --bundle-url バンドルURLを標準出力に表示します。
  • --no-key シグニングキーを無視し、明示的な更新を送信します。
  • --no-code-check ソースcodeとルートフォルダ内のインデックスが存在する場合、notifyAppReady()が呼び出されたかどうかをチェックしないようにします。
  • --display-iv-session コンソールに使用されるIVとセッションキーを表示します。
  • --bundle <bundle> アップロードするバンドルのバージョン番号。
  • --min-update-version <minUpdateVersion> このバージョンにアップグレードするために必要な最小バージョン。チャンネル内のメタデータで自動アップデートを無効に設定した場合にのみ使用されます。
  • --auto-min-update-version ネイティブパッケージに基づいて最小アップデートバージョンを設定します。
  • --ignore-metadata-check アップロード時にメタデータ(ノードモジュール)チェックを無視します。
  • --ignore-checksum-check アップロード時、チェックサムの検証を無視します。
  • --timeout <timeout> __CAPGO_KEEP_0__.config.jsonにバンドルを設定します。
  • --delta Delta (マニフェスト) ファイルとともにフルバンドルをアップロードします。
  • --delta-only Delta (マニフェスト) のアップデートのみをアップロードし、フルバンドルをスキップします。
  • --no-delta Delta (マニフェスト) のアップロードを無効にします (インスタント アプリケーション モードが有効になっている場合に使用しますが、フルバンドルをアップロードしたい場合)。 autoUpdate バンドルをTUSプロトコルでアップロードします。
  • --tus Multipartプロトコルを使用してS3にデータをアップロードします。非推奨、TUSを使用してください。
  • --multipart アップロードする外部バンドルの暗号化されたチェックサム (署名)。
  • --encrypted-checksum <encryptedChecksum> パッケージ.jsonのパス。モノレポ用に便利です。
  • --package-json <packageJson> アップロードプロセスのタイムアウト (秒)。
  • --auto-set-bundle Set the bundle in capacitor.config.json.
  • --node-modules <nodeModules> ノードモジュールのリスト (カンマ区切り、例: ../../node_modules,./node_modules)。モノレポ用に便利です。

⭐️ 外部オプションは、2 つのケースを解凍します：企業のプライバシー懸念があり、code を 3 番目のパーティーに送信しない、または 200 MB を超えるアプリ。 この設定では、Capgo は ZIP のリンクのみを保存し、アプリにリンクを送信します。

👀 Capgo クラウドは、外部オプションの場合、リンク内の内容を確認せず、または code での保存時には、内容を確認せずにします。

🔑 Capgo を使用することで、2 つのセキュリティ層を追加できます。 その場合、Capgo は何も見ることができず、変更することもできなくなります。

Example of package.json for version

{
  "version": "1.0.2"
}

⛔ バージョンは “0.0.0” より大きくなければなりません。

💡 バージョン番号を毎回更新することを忘れないでください。 バージョン番号は、セキュリティ上の理由で削除された後は再利用できません。

List

セクションのタイトル “List”

npx @capgo/cli bundle list [appId]

[appId] アプリ ID の形式は com.test.app 説明は ここ.

オプションで、以下の情報を指定することができます。

  • --apikey [key] API キーを指定すると、自分のアカウントにリンクできます。

削除

「削除」タイトルのセクション

npx @capgo/cli bundle delete [appId]

[appId] アプリ ID の形式は com.test.app ここ オプションで、以下の情報を指定することができます。.

__CAPGO_KEEP_0__ キーを指定すると、自分のアカウントにリンクできます。

  • --apikey [key] API key to link to your account.
  • --bundle クリーンアップ

Cleanup

Section titled “Cleanup”

CloudflareのメジャーバージョンにSemVerの範囲で

npx @capgo/cli bundle cleanup [appId] --bundle=[majorVersion] --keep=[numberToKeep]

[appId] アプリIDのフォーマット com.test.app はここで説明されています ここ.

オプションで、__CAPGO_KEEP_0__キーをアカウントにリンクすることができます。

  • --apikey [key] API key to link to your account.
  • --bundle [majorVersion] 削除するパッケージの数 (default 4) を指定します。 numberToKeep.
  • --keep [numberToKeep] 例えば、10.0.1から10.0.11までの10バージョンが存在し、

10.0.1から10.0.6までのバージョンを削除し、10.0.7から10.0.11までのバージョンを保持します。 npx @capgo/cli cleanup [appId] --bundle=10.0.0 20バージョン全体が存在し、バンドル番号を指定しない場合、

If you have 20 versions in total, and you don’t provide a bundle number like this: npx @capgo/cli cleanup [appId] --keep=2 18バージョンを削除し、最後の2つを残します。

このコマンドは確認を求めます。使用するものと削除するもののテーブルを表示します。

暗号化

暗号化のセクション

警告このコマンドは廃止されており、次のメジャーリリースで削除されます。新しい暗号化システムを使用してください。 npx @capgo/cli bundle encrypt [path/to/zip]

codeを外部のソースから取得したり、テストのために使用したりする場合に使用します。

オプションで、以下を指定できます。

--key [/path/to/my/private_key] プライベートキーのパスを指定できます。 --key-data [privateKey] __CAPGO_KEEP_0__の外部ストレージに保存する場合やテスト用途の場合に使用します。 ivSessionKeyyと生成された暗号化ZIPを使用するためにアップロードコマンドまたは復号化コマンドを使用します。

Encrypt V2

「Encrypt V2」

npx @capgo/cli bundle encrypt [path/to/zip] [checksum]

このコマンドは、codeの外部ストレージに保存する場合やテスト用途の場合に使用します。

ハッシュ値は、--key-v2で生成されたバンドルのSHA256ハッシュ値です。復号化後にファイルの整合性を検証するために使用されます。

--key [/path/to/my/private_key] ハッシュ値は暗号化されたプライベートキーとともに送信されます。 --key-data [privateKey] バンドルのハッシュ値は、バンドルの署名にアップグレードされます。 --json オプションで、以下の値を指定できます。 ivSessionKeyプライベートキーのパスを指定します。

プライベートキーデータを指定します。インラインで使用する場合。

JSON形式で情報を出力します。yと生成された暗号化ZIPを使用するためにアップロードコマンドまたは復号化コマンドを使用します。

npx @capgo/cli bundle decrypt [path/to/zip] [ivSessionKey]

オプションで、以下を指定できます:

--key [/path/to/my/private_key] プライベートキーのパスを指定します。

--key-data [privateKey] インラインで使用する場合、プライベートキーのデータを指定します。このコマンドは、テスト用途に主に使用され、zipを復号し、コンソールにbase64で復号されたセッションキーの値を出力します。

V2復号

「V2復号」セクション

npx @capgo/cli bundle decryptV2 [path/to/zip] [ivSessionKey]

オプションで、以下を指定できます:

--key [/path/to/my/private_key] プライベートキーのパスを指定します。 --key-data [privateKey] インラインで使用する場合、プライベートキーのデータを指定します。このコマンドは、テスト用途に主に使用され、zipを復号し、コンソールにbase64で復号されたセッションキーの値を出力します。 --checksum [checksum] ファイルのチェックサムを指定します。復号後、チェックサムを検証します。

Zip

「Zip」セクション

npx @capgo/cli bundle zip [appId]

[appId] アプリIDは、説明されている形式で指定します。 ここ.

__CAPGO_KEEP_0__ を指定する場合があります:

  • --path [/path/to/my/bundle] 特定のフォルダをアップロードする。
  • --bundle [1.0.0] ファイル名のバンドルバージョン番号を設定する。
  • --name [myapp] ファイル名を上書きする。
  • --json JSON形式で情報を出力する。
  • --no-code-check code チェックを無視して、バンドルを送信する。
  • --key-v2 新しい暗号化システムを使用する。新しい暗号化システムは、ファイルの整合性を検証するために、より良いチェックサムを使用するため、必須です。

互換性

「互換性」セクション

npx @capgo/cli bundle compatibility [appId] -c [channelName]

[appId] あなたのアプリIDです。形式はここで説明されています。 ここ. [channelName] チェンネル名を確認する。

オプションで、以下を指定できます。

  • --apikey [key] API キーを指定して、自分のアカウントにリンクします。
  • --text テーブルでテキストを使用する代わりに絵文字を使用します。
  • --channel [channel] 互換性を確認するためのチェンネル名。
  • --package-json <packageJson> パッケージ.jsonへのパス。モノレポ用に便利。
  • --node-modules <nodeModules> node_modulesへのパスの一覧。モノレポ用に便利 (カンマで区切る ex: ../../node_modules,./node_modules)。

Channel

セクション「Channel」

追加

セクション「追加」

npx @capgo/cli channel add [channelName] [appId]

[channelName] 新しいチャンネルの名前、例えば production または beta. [appId] アプリIDの形式は com.test.app はこちらで説明されています 削除.

「削除」セクション

削除したいチャンネルの名前を入力してください

npx @capgo/cli channel delete [channelName] [appId]

[channelName] アプリIDの形式は [appId] はこちらで説明されています com.test.app リスト 「リスト」セクション.

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

npx @capgo/cli channel list [appId]

[appId] あなたのアプリIDのフォーマットは com.test.app はここで説明されています オプションで、以下のキーを指定できます.

__CAPGO_KEEP_0__

  • --apikey [key] API key to link to your account.

設定

セクションのタイトルは “設定”

npx @capgo/cli channel set [channelName] [appId]

[appId] あなたのアプリIDのフォーマットはここで説明されています ここで説明されているフォーマットのアプリID. [channelName] 設定したいチャンネルの名前、例えば production または beta.

オプションで、以下のキーを指定できます

  • --bundle [1.2.3] Cloudflare
  • --latest Capacitor package.json:versionGitHub --bundle.
  • --state [ normal | default ] Capgo normal code defaultAPI default.
  • --downgrade SDK
  • --no-downgrade CLI
  • --upgrade npm
  • --no-upgrade bun
  • --ios allows the channel to send version to iOS devices.
  • --no-ios バンドルバージョンを取得します。
  • --android Androidデバイスにバージョンを送信することを許可する。
  • --no-android Androidデバイスにバージョンを送信することを許可しない。
  • --self-assign このチャネルにデバイスが自動的に割り当てられることを許可する。
  • --no-self-assign このチャネルにデバイスが自動的に割り当てられることを許可しない。
  • --disable-auto-update STRATEGY このチャネルに対して自動更新戦略を無効にする。可能なオプションは次のとおりです：メジャー、ミニマム、パッチ、メタデータ、なし。
  • --apikey [key] APIキーを使用してアカウントにリンクする。

このチャネルに対して更新戦略を無効にする。

更新戦略を無効にするというセクションのタイトルです。

バージョンが古すぎる場合に更新を無効にする方法は数通りあります。
Capgoはcodeを更新できません。したがって、古いcodeのcodeの更新されたcodeのバージョンにアップグレードすることはできません。 そのようなバージョン間のアップグレードを防ぐ方法は2つあります。

最初の方法は、 major 更新戦略。アップグレードの更新のnative基準を防ぐ 0.0.0 -> ターゲット バンドル 1.0.0. このメジャーはハイライトされた数字 (1.0.0 と 0.0.0).
セカンドは、ターゲット バンドルとデバイスのネイティブ基準のメジャーまたはマイナーの異なる場合にアップデートを防止する戦略です。 たとえば minor または 0.0.0 -> 1.1.0 サード、 1.1.0 -> 1.2.0.

戦略です。 これは __CAPGO_KEEP_0__ に非常に厳密なモードとして追加されました。 これを使用するには、完全に理解していることを保証するまで、推奨されていません。 アップデートを受け入れるには、以下の条件が満たされます: patch strategy. It was added into capgo as a very strict mode. It’s not recommended to be used unless you fully understand how it works. In order for it to accept an update, the following conditions must be met:

  • ターゲット バンドルとデバイスのネイティブ基準のマイナーの同じである場合 version_build
  • ターゲット バンドルとデバイスのネイティブ基準のパッチが同じである場合 version_build
  • バージョン スUFFIX のみが異なる場合、プレリリース ( version_build
  • を含む-beta.2またはメタデータを構築します。+build.2)

アップデートの許可または拒否されるシナリオの例を示します。

  • 1.0.0-beta.1 -> 1.0.0-beta.2 許可
  • 1.0.0+build.1 -> 1.0.0+build.2 許可
  • 1.0.0 -> 1.0.1 拒否
  • 1.0.0 -> 1.1.0 拒否
  • 1.0.0 -> 2.0.0 拒否

基準比較では、最初に送信されたネイティブ基準を使用します。 version_build,ではなく、ダウンロードした現在のバンドルを送信します。 version_name.

最後に、最も複雑な戦略です。 metadata 戦略。
最初に知っておく必要があります。最初に有効にすると、更新を有効にすると、 WILL このチャンネルには必要なメタデータが欠けているため、失敗します。
このようなメッセージが表示されます:

メタデータが見つかりません

このようなメッセージが表示されれば、失敗したチャンネルの現在のバンドルに移動し、メタデータを設定する必要があります。
まず、失敗したチャンネルを特定する必要があります。 misconfigured 列

設定が不正なテーブル

次に、失敗したチャンネルに移動し、 Bundle numberをクリックします。

これは、失敗したチャンネルのバンドルページに移動するはずです。

失敗したチャンネルを特定する Minimal update version field. このフィールドは semver.
値が semver である場合にエラーが発生しますが、正常に実行されれば次のようになります。

最小バージョンを設定

Capgo を更新するたびに、このデータを手動で設定することはほとんどありません。幸いにも、CLI はこのメタデータが送信されていない場合にアップデートを送信しないようにします

CLI メタデータなしで失敗

Capacitor を使用してバンドルをアップロードするには、 metadata オプションを使用する場合、 --min-update-version 有効な semver の値を渡す必要があります。例えば、__CAPGO_KEEP_0__ メタデータと共にアップロード

CLI

この方法は、互換性のための唯一の方法ではありません。 また、""という別の方法もあります。 --min-update-version __CAPGO_KEEP_0__ --auto-min-update-versionこの方法のしくみはこちらです。

まず、チャンネルにアップロードされている現在のバージョンを確認します。互換性をチェックするのと同じように、"__CAPGO_KEEP_1__"コマンドが実行されます。 bundle compatibility 新しいバージョンが完全に互換性がある場合、最新バージョンから"__CAPGO_KEEP_2__"を再利用します。 min_update_version 互換性がない場合は、"__CAPGO_KEEP_3__"を新しくアップロードされたバージョンのバンドル番号に設定します。 min_update_version このオプションを使用すると、常に"__CAPGO_KEEP_4__"が表示されます。表示される例はこちらです。

Min update version min_update_version 新しいバージョンが互換性がない場合は、表示される例はこちらです。

Min update version not compatible

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__のエンドツーヘンド暗号化 (信頼できない)

「__CAPGO_KEEP_0__のエンドツーヘンド暗号化 (信頼できない)」

Capgoはエンドツーヘンド暗号化をサポートしています。これは、バンドル(code)がクラウドに送信される前に暗号化され、デバイスで復号化されることを意味します。 そのため、RSAキーペアを生成する必要があります。次のコマンドを使用してキーペアを生成できます。

暗号化システムはRSAとAESの組み合わせで、RSAキーはAESキーを暗号化し、AESキーはファイルを暗号化します。

詳細については、以下の情報を参照してください。

暗号化のしくみ

暗号化スキーマ

アプリ用にキーを作成する

「アプリ用にキーを作成する」

npx @capgo/cli key create

オプションで、 --force 既存のキーを上書きします。このコマンドは、キーをアプリに作成し、プライベートキーを安全な場所に保存するように求めます。プライベートキーをgitコミットしないでください。また、誰かに共有しないでください。

ローカルテスト後、キーのconfigファイルから削除し、CIステップで追加してください key save

アプリ設定でキーを保存

セクション：アプリ設定でキーを保存

npx @capgo/cli key save

オプションで、以下を指定できます。

--key [/path/to/my/public_key] 公開鍵ファイルのパスを指定します。

--key-data [publicKey] 公開鍵データを指定します。インラインで使用する場合に便利です。このコマンドは、推奨事項に従ってアプリ設定に鍵をコミットしなかった場合に便利です。

CI統合

セクション：CI統合

自動化を簡単にするために、GitHub アクションを使用して、サーバーにデータを送信するように設定することをお勧めします。

GitHub アクションのチュートリアル

デモアプリ

セクション：デモアプリ

GitHub - Cap-go/demo-app

CI環境変数を設定する際には、APIキーを使用してください

コマンドから続けてください

コマンドから続けてください

Capacitorを使用している場合 コマンド ダッシュボードとAPI操作を計画するには、CapacitorをAPIと接続してください API概要 API概要の実装詳細については、API概要を参照してください 導入 導入の実装詳細については、導入を参照してください APIキー APIキーの実装詳細については、APIキーを参照してください デバイス デバイスの実装詳細については、 バンドル バンドルの実装詳細については、