コマンド

このページはガイド付きの概要です。正確なフラグについては、現在のコマンドリファレンスを参照してください: アプリ, バンドル, チャネル, および ビルド.

使用方法

あなたのアプリのフォルダ内で、capacitorプロジェクトを適切に起動していることを確認してください。

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

Init

npx @capgo/cli@latest init [apikey]

このメソッドは、ステップバイステップであなたを導きます。

このメソッドはあなたのアプリをCapgoに追加します。また、codeをあなたのアプリに追加してアップデートを検証します。さらに、アプリをビルドし、Capgoにアップロードします。そして、アップデートが正常に動作するかどうか確認します。

ログイン

npx @capgo/cli login [apikey]

このメソッドはあなたの__CAPGO_KEEP_0__アカウントの情報を保存します。 apikey このメソッドはあなたの__CAPGO_KEEP_0__アカウントの情報を保存します。

注意

使用 --apikey=******** 任意のコマンドでオーバーライドします

任意の場合、次のことができます:

--local このコマンドは、ローカルリポジトリにAPIキーを保存し、Gitで無視します。 ドクター 「ドクター」のセクション

Capgoパッケージの最新バージョンにアップデートしているかどうかを確認するコマンドです。

npx @capgo/cli doctor

Capgo

パッケージ

アプリ

追加

npx @capgo/cli app add [appId]

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

💡 すべてのオプションは、指定されていない場合、configで推測されます。

オプションは任意ですが、以下のものがあります:

• --icon [/path/to/my/icon] to have a custom icon display in Capgo web app.
• --name [test] リスト内のカスタム名前を指定します。
• --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はこちら ここに説明があります。.

オプションとして、以下のいずれかを指定できます。

• --icon [/path/to/my/icon] Capgoのウェブアプリにカスタムアイコンを表示する
• --name [test] リスト内のカスタム名を指定する
• --retention [retention] アプリケーションバンドルの保持期間（日）、0を指定すると無制限。
• --expose-metadata [true|false] バンドルメタデータ（リンクとコメント）をプラグインに公開する。
• --preview または --no-preview バンドルとチャンネル プレビュー QR コードの有効化または無効化を目的としています。
• --allow-device-custom-id または --no-allow-device-custom-id カスタムデバイスIDを制御する。
• --block-provider-infra-requests または --no-block-provider-infra-requests GoogleとAppleのデータセンターの要求をブロックするためのコントロールを行う。
• --build-timeout-minutes [5-360] ネイティブビルドのタイムアウトを設定します。
• --ios-store-url [url] または --android-store-url [url] ストアのURLを設定します。
• --default-upload-channel [channel] デフォルトアップロードチャンネルを設定します。
• --default-download-channel [channel] デフォルトのダウンロードチャネルを設定するか --disable-download-channels すべてのダウンロードチャンネルを非公開にする。
• --apikey [key] API キーをアカウントにリンクする。

リスト

npx @capgo/cli app list [appId]

[appId] アプリIDのフォーマットはこちら com.test.app ここに説明があります オプションで、以下のキーを指定できます。.

__CAPGO_KEEP_0__ キーをアカウントにリンクする。

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

「削除」のセクション

npx @capgo/cli app delete [appId]

[appId] List com.test.app は説明されています。 ここ.

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

• --apikey [key] API キーを指定すると、自分のアカウントにリンクできます。
• --bundle バージョン番号を指定すると、このバージョンだけを削除します。

デバッグ

npx @capgo/cli app debug [appId]

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

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

• --apikey [key] API キーを指定すると、自分のアカウントにリンクできます。
• --device デバッグしたいデバイスに特定されたもの

設定

npx @capgo/cli app setting [path]

Capacitorの設定を編集してください。

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

または --string または --bool!

オプション:

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

Bundle

アップロード

npx @capgo/cli bundle upload [appId]

[appId] アプリケーションIDはこちらで説明されています ここ.

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

• --apikey <apikey> API key to link to your account.
• --path <path> リンクするチャンネル
• --channel <channel> Bundle
• --external <url> 外部URLにリンクするのではなく、Capgo Cloudにアップロードする。
• --iv-session-key <key> バンドルURLの外部オプションのIVとセッションキーを設定します。
• --s3-endpoint <s3Endpoint> S3エンドポイントのURLです。デルタアップロードや外部オプションは機能しません。
• --s3-region <region> あなたのS3バケットのリージョンです。
• --s3-apikey <apikey> APIキーはあなたのS3エンドポイントです。
• --s3-apisecret <apisecret> APIシークレットはあなたのS3エンドポイントです。
• --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> アップロードするバンドルに含まれるバンドルバージョン番号。
• --auto-bump [level] チャンネルの関連付けられたバンドルから自動的にインクリメントします。そうでない場合は、リモートアプリの最新バージョンを使用します。レベル: major, minor (デフォルト) patch (エイリアス) fix), metadata, または ai ワーカーAIは、ローカルファイルを前の Capgo/チャンネルデルタマニフェストと比較し、レベルを推測し、短い理由をログします。AIをスキップし、 patch if no previous Capgo version). Bumps until a free name is found (deleted names stay occupied). Cannot be combined with --bundle.
• --min-update-version <minUpdateVersion> このバージョンにアップグレードするには必要な最小バージョンです。自動アップデートを無効にした場合にのみ、チャンネル内のメタデータで使用されます。
• --auto-min-update-version ネイティブパッケージに基づいて最小アップデートバージョンを設定します。
• --ignore-metadata-check アップロード時にメタデータ (node_modules) チェックを無視します。
• --ignore-checksum-check アップロード時にチェックサムチェックを無視します。
• --timeout <timeout> アップロードプロセスのタイムアウト (秒)。
• --delta Delta (マニフェスト) ファイルとフルバンドルを一緒にアップロードします。
• --delta-only フルバンドルをスキップして、Delta (マニフェスト) のアップデートのみアップロードします。
• --no-delta Delta (マニフェスト) のアップロードを無効にします (インスタント適用モードが有効になっている場合に使用しますが、フルバンドルをアップロードしたい場合は便利です)。 autoUpdate バンドルをTUSプロトコルでアップロードします。
• --tus S3にデータをアップロードするために、Multipartプロトコルを使用します。 (TUSを使用することをお勧めします)。
• --multipart アップロード時に暗号化されたチェックサム (署名) を使用します。外部バンドルをアップロードする場合にのみ使用されます。
• --encrypted-checksum <encryptedChecksum> 外部バンドルをアップロードする場合にのみ使用されます。
• --package-json <packageJson> パッケージ.jsonのパス。モノレポ用に便利。
• --auto-set-bundle capacitor.config.jsonにバンドルを設定。
• --node-modules <nodeModules> モノレポ用にnode_modulesのパスの一覧。カンマで区切って指定する ex: ../../node_modules,./node_modules

⭐️ External option helps to unlock 2 cases: corporate with privacy concern, don’t send the code to a third part and app bigger than 200 MB. With this setting, Capgo store only the link to the zip and sends the link to all apps.

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

🔑 二重のセキュリティを追加するには、暗号化を使用すると、Capgoは内容を確認または変更できなくなり、信頼できない状態になります。

例 package.json バージョン

{
  "version": "1.0.2"
}

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

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

リスト

npx @capgo/cli bundle list [appId]

[appId] __CAPGO_KEEP_0__キーを付けてアカウントにリンクすることができます。 com.test.app 削除 アプリIDのフォーマットについては.

ここで説明されています。

• --apikey [key] オプションで、APIキーを付けてアカウントにリンクすることができます。

削除

npx @capgo/cli bundle delete [appId]

[appId] ここで説明されています。 com.test.app オプションで、__CAPGO_KEEP_0__キーを付けてアカウントにリンクすることができます。 削除.

アプリIDのフォーマットについては

• --apikey [key] API を使用してアカウントにリンクします。
• --bundle __CAPGO_KEEP_0__ を使用してアカウントにリンクします。

クリーンアップ

メジャーバージョンを含む SemVer の範囲で Cloud へのアップロード

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] 削除したいパッケージの数 (デフォルト 4) を指定できます。 numberToKeep.
• --keep [numberToKeep] Cleanup

例えば、10.0.1から10.0.11までの10バージョンがあって、__CAPGO_KEEP_0__を使用した場合 npx @capgo/cli cleanup [appId] --bundle=10.0.0 __CAPGO_KEEP_0__は10.0.1から10.0.6までのバージョンを削除し、10.0.7から10.0.11までのバージョンを残します。

20バージョン全体があって、__CAPGO_KEEP_0__のバンドル番号を指定しない場合 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] プライベートキーのデータを指定します。インラインで使用する場合にのみ使用します。 コマンドは、y と暗号化された zip を生成し、アップロードコマンドまたは復号化コマンドと一緒に使用します。 ivSessionKey暗号化 V2

「暗号化 V2」セクション

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

This command is used when you use external source to store your code or for test purpose. The checksum is the sha256 of the bundle (generated by —key-v2), it is used to verify the integrity of the file after decryption. It will be enncrypted with the private key and sent along with the bundle. In encryption v2 the checksum is upgraded to become a “signature” of the bundle.

プライベートキーのパスを指定します。

--key [/path/to/my/private_key] プライベートキーのデータを指定します。インラインで使用する場合にのみ使用します。 --key-data [privateKey] 情報を JSON 形式で出力します。 コマンドは、y と暗号化された zip を生成し、 --json アップロードコマンドまたは復号化コマンドと一緒に使用します。 ivSessionKeyyを使用して暗号化されたzipを生成し、uploadコマンドまたはdecrytコマンドで使用します。

復号

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

復号

--key [/path/to/my/private_key] オプションとして、以下を指定できます。

--key-data [privateKey] プライベートキーのパスを指定します。

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

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

復号V2

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

Zip

npx @capgo/cli bundle zip [appId]

[appId] アプリケーションIDは「Zip」で、フォーマットはここで説明されています。 ここ.

オプションで、以下のいずれかを指定できます。

• --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] __CAPGO_KEEP_0__キーを使用してアカウントにリンクする テキストを使用する. [channelName] チェックするチャンネル名

オプションで、以下のいずれかを指定できます。

• --apikey [key] API key to link to your account.
• --text パッケージ.jsonへのパス。モノレポ用
• --channel [channel] node_modulesへのパスの一覧。モノレポ用(カンマ区切り: ex: ../../node_modules,./node_modules)
• --package-json <packageJson> Channel
• --node-modules <nodeModules> Section titled “Channel”

アプリIDはここで説明されている形式になります

追加

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

[channelName] 新しいチャンネルの名前を入力してください production または beta. [appId] 削除 com.test.app 削除 削除したいチャンネルの名前を入力してください.

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

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

[channelName] 削除したいチャンネルの名前を入力してください [appId] 削除したいチャンネルの名前を入力してください com.test.app 削除したいチャンネルの名前を入力してください ここ.

リスト

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のフォーマットは ここで説明されています. [channelName] 指定するチャンネルの名前、例えば production または beta.

オプションで、

• --bundle [1.2.3] あなたのアプリのバンドルがすでにクラウドに送信されている場合、チャンネルにリンクすることができます。
• --latest バンドルバージョンを取得する package.json:version, これは --bundle.
• --state [ normal | default ] 設定するチャンネル状態、例えば normal または defaultチャンネルを設定する default.
• --downgrade チャンネルを設定する
• --no-downgrade チャンネルを設定する
• --upgrade チャンネルを設定する
• --no-upgrade __CAPGO_KEEP_0__
• --ios このアカウントにリンクするための__CAPGO_KEEP_0__キー
• --no-ios このチャンネルに自動更新戦略を無効にする。
• --android 自動更新戦略の可能なオプションは次のとおりです: メジャー、ミニマム、パッチ、メタデータ、なし。
• --no-android デバイスがこのチャンネルに自分で割り当てることを許可する。
• --self-assign デバイスがこのチャンネルに自分で割り当てることを許可しない。
• --no-self-assign このチャンネルにiOSデバイスにバージョンを送信することを許可する。
• --disable-auto-update STRATEGY このチャンネルにiOSデバイスにバージョンを送信することを許可しない。
• --apikey [key] API key to link to your account.

このチャンネルにAndroidデバイスにバージョンを送信することを許可しない。

バージョンをiOSデバイスに送信することをこのチャンネルに許可する。
Capgo は更新できません。code は更新できません。したがって、古い code のネイティブ バージョンから更新された code のネイティブ バージョンにアップグレードすることはできません。 そのようなアップグレードは可能にするにはいくつかの方法があります。

第一の戦略です。__CAPGO_KEEP_0__ は、ネイティブ バイリンジ間のアップデートを防止します。 major 目標バンドル -> ターゲット バンドル 0.0.0 メジャーはハイライトされた数字です (0.0.0 と) 1.0.0第二の戦略です。__CAPGO_KEEP_0__ は、ターゲット バンドルとデバイスのネイティブ バイリンジ間のメジャーまたはマイナーの異なる場合にアップデートを防止します。1または 0.0.0).
第三の戦略です。__CAPGO_KEEP_0__ では、厳格なモードとして追加されました。使用することをお勧めしません。使用する場合は、どのように機能するかを完全に理解していることを確認してください。 アップデートを許可するには、次の条件が満たされます: minor メジャーはターゲット バンドルと同じです 0.0.0 -> 1.1.0 メジャーはターゲット バンドルと同じです 1.1.0 -> 1.2.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
• ターゲットのバンドルと version_build
• バージョンサフィックスのみが異なる場合、プリリリース (-beta.2) またはビルドメタデータ (+build.2)

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

• 1.0.0-ベータ.1 -> 1.0.0-ベータ.2 許可
• 1.0.0+ビルド.1 -> 1.0.0+ビルド.2 許可
• 1.0.0 -> 1.0.1 拒否
• 1.0.0 -> 1.1.0 拒否
• 1.0.0 -> 2.0.0 拒否

戦略の比較は、送信されたネイティブのベースラインを使用しますが、ダウンロードした現在のバンドルを送信した version_build、ではなく version_name.

最後に最も複雑な戦略です。 metadata 戦略。
最初は、Capgo Builder / ネイティブ クラウド ビルド製品ページの "Native Build Builder Credit First" メッセージキー (Native Build Builder Credit First) を参照してください。 WILL 失敗します。
チャンネルが必要なメタデータを欠いています。

必要なメタデータが欠けているチャンネルが見つかりません。
必要なメタデータが欠けているチャンネルが見つかりません。 misconfigured 必要なメタデータが欠けているチャンネルが見つかりません。

ミス設定テーブル Bundle number. このボタンをクリックすると、バンドルページに移動します。

そこで、フィールドを埋めます。この値は、 Minimal update version セマンティックバージョニング 指定した値がセマンティックバージョニングでない場合、エラーが発生しますが、すべて正常に実行された場合、以下のような画面が表示されます。.
最小バージョンを設定します。

CLI メタデータなしで失敗

オプションを指定する必要があります。 metadata オプションを指定する必要があります。 --min-update-version オプションを指定する必要があります。 バージョン管理規則 例えば、次のようになります。

その --min-update-version は、互換性のための唯一の方法ではありません。 また、 --auto-min-update-versionがあります。ここでは、そのしくみをご紹介します。

まず、現在チャンネルにアップロードされているバージョンを確認します。互換性をチェックするのと同じように bundle compatibility コマンドがチェックします。 2番目に、新しいバージョンが完全に互換性がある場合、最新のバージョンから min_update_version を再利用します。 互換性がない場合は、 min_update_version を新しいバージョンの

に設定します。 min_update_version このオプションを使用する場合、常に

新バージョンが互換性がない場合は、次のようになります

エンドツーヘンド暗号化（信頼できない）

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

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

暗号化システムの詳細については、以下を参照してください。

暗号化スキーマ

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

npx @capgo/cli key create

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

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

アプリ設定ファイルにキーを保存

npx @capgo/cli key save

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

--key [/path/to/my/public_key] パブリック キー ファイルのパスを指定します。

--key-data [publicKey] パブリック キー データを指定します。インラインで使用する場合に便利です。アプリ設定ファイルにキーをコミットしなかった場合に使用します。

CI統合

自動化を実行するには、GitHub アクションを実行することをお勧めします。GitHub アクションのチュートリアルを参照してください。

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

デモアプリ

GitHub - Cap-go/demo-app

API キーを使用してCI環境変数を設定することを忘れないでください

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

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