コマンド
インストール手順とこのプラグインの全てのマークダウンガイドを含む設定プロンプトをコピーする
このページはガイド付きの概要です。正確なフラグについては、現在のコマンドリファレンスを参照してください: アプリ, バンドル, チャネル, および ビルド.
使用方法
使用方法Capgoアプリのフォルダ内で、capacitorプロジェクトを適切に起動していることを確認してください。
Init
Initnpx @capgo/cli@latest init [apikey]
このメソッドは、ステップバイステップで導入をサポートします。
このメソッドは、Capgoにアプリを追加します。また、codeをアプリに追加してアップデートを検証します。さらに、アプリをビルドし、Capgoにアップロードします。そして、アップデートが正常に動作するかどうかを確認します。
ログイン
ログインnpx @capgo/cli login [apikey]
このメソッドは、__CAPGO_KEEP_0__アカウントにログインするためのメモリーサービスです。 apikey このメソッドは、__CAPGO_KEEP_0__アカウントにログインするためのメモリーサービスです。
任意のコマンドに使用することができます。
--local 任意のコマンドに使用することができます。 APIキー ローカルリポジトリに保存し、gitignoreします。
npx @capgo/cli doctor
Command to check if you are up-to-date with Capgo packages.
バグレポートの際にも有用なコマンドです。
npx @capgo/cli app add [appId]
[appId] アプリ ID の形式は com.test.app ここで説明されています ここ.
💡 オプションがすべて自動で推測されます。指定しない場合。
オプションを指定する場合は、以下のいずれかになります。
--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の場合、アイコンはリソースフォルダ内の推測値になります。
{ "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-previewCapacitorライブアップデートの代替品の比較ページです。Capacitor、Appflow、Capawesomeの代替品の比較ページです。Capacitor、Appflow、Capawesomeの代替品の比較ページです。Capacitor、Appflow、Capawesomeの代替品の比較ページです。Capacitor、Appflow、Capawesomeの代替品の比較ページです。Appflowの代替品の比較ページです。--allow-device-custom-idバンドルとチャンネルのプレビューQRコードを有効または無効にします。--no-allow-device-custom-idまたは--block-provider-infra-requestsCapacitorライブアップデートの代替品の比較ページです。Capacitor、Appflow、Capawesomeの代替品の比較ページです。Capacitor、Appflow、Capawesomeの代替品の比較ページです。Capacitor、Appflow、Capawesomeの代替品の比較ページです。Capacitor、Appflow、Capawesomeの代替品の比較ページです。Appflowの代替品の比較ページです。--no-block-provider-infra-requestsカスタムデバイスIDを制御します。--build-timeout-minutes [5-360]または--ios-store-url [url]Capacitorライブアップデートの代替品の比較ページです。Capacitor、Appflow、Capawesomeの代替品の比較ページです。Capacitor、Appflow、Capawesomeの代替品の比較ページです。Capacitor、Appflow、Capawesomeの代替品の比較ページです。Capacitor、Appflow、Capawesomeの代替品の比較ページです。Appflowの代替品の比較ページです。--android-store-url [url]GoogleとAppleのデータセンターの要求をブロックすることを制御します。--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.
「削除」のセクション
アプリIDのフォーマットはこちらで説明されています。npx @capgo/cli app delete [appId]
[appId] ここ 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>- 設定をブール値に設定します
バンドル
バンドルアップロード
アップロードnpx @capgo/cli bundle upload [appId]
[appId] あなたのアプリケーションIDです。形式については ここ.
__CAPGO_KEEP_0__ キーを指定すると、あなたのアカウントにリンクできます。
--apikey <apikey>API key to link to your account.--path <path>リンクするチャンネル--channel <channel>バンドル--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-sslS3アップロードの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をスキップし、patchif 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-onlyフルバンドルをスキップし、デルタ (マニフェスト) のみアップロードする。--no-deltaデルタ (マニフェスト) のアップロードを無効にする (インスタント アプリケーション モードが有効になっている場合に便利)。autoUpdatetus プロトコルを使用してバンドルをアップロードする。--tusS3 へのデータのアップロードに使用するマルチパートプロトコル (非推奨、tus を使用することを推奨します)。--multipart外部バンドルをアップロードする場合にのみ使用される暗号化されたチェックサム (署名)。--encrypted-checksum <encryptedChecksum>__CAPGO_KEEP_0__--package-json <packageJson>A path to package.json. Useful for monorepos.--auto-set-bundlecapacitor.config.jsonのバンドルを設定します。--node-modules <nodeModules>A list of path to node_modules. Useful for monorepos (comma separated ex: ../../node_modules,./node_modules)
⭐️ 外部オプションは、2つのケースを解凍します: 企業のプライバシー懸念、3番目のパーティーにcodeを送信しない、または200MBを超えるアプリ。 この設定では、Capgoはzipへのリンクのみを保存し、すべてのアプリにリンクを送信します。
👀 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 key to link to your account.
セクションのタイトル “削除”
アプリIDのフォーマットについてはnpx @capgo/cli bundle delete [appId]
[appId] ここで説明されています。 com.test.app 任意に、以下のオプションを指定することができます。 削除.
__CAPGO_KEEP_0__キーを付けてアカウントにリンクすることができます。
--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]バージョン番号を指定すると、このバージョンだけを削除します。numberToKeep.--keep [numberToKeep]クリーンアップ
例えば、10.0.1から10.0.11までの10バージョンがあって、__CAPGO_KEEP_0__を使用すると、10.0.1から10.0.6までのバージョンが削除され、10.0.7から10.0.11までのバージョンが残ります。 npx @capgo/cli cleanup [appId] --bundle=10.0.0 バンドル番号を指定しない場合、合計20バージョンがあって、__CAPGO_KEEP_0__を使用すると、18バージョンが削除され、最後の2バージョンが残ります。
バンドル番号を指定しない場合、合計20バージョンがあって、__CAPGO_KEEP_0__を使用すると、18バージョンが削除され、最後の2バージョンが残ります。 npx @capgo/cli cleanup [appId] --keep=2 このコマンドは、削除されるものと残るもののテーブルを表示し、確認を求めます。
注意
暗号化セクション
注意: このコマンドは廃止され、次のメジャーリリースで削除されます。新しい暗号化システムを使用してください。__CAPGO_KEEP_0__
npx @capgo/cli bundle encrypt [path/to/zip]
このコマンドは、外部のソースを使用して code を保存する場合やテストの目的で使用する場合に使用されます。
オプションで、以下のいずれかを指定できます。
--key [/path/to/my/private_key] プライベートキーのパスを指定します。
--key-data [privateKey] プライベートキーのデータを指定します。インラインで使用する場合に指定します。
コマンドは、y を生成し、暗号化された zip を出力し、アップロードコマンドまたは復号化コマンドと使用します。 ivSessionKey暗号化 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 「暗号化 V2」 ivSessionKeyyと使用するためにアップロードコマンドまたは復号コマンドと共に暗号化されたzipを生成します。
復号
復号npx @capgo/cli bundle decrypt [path/to/zip] [ivSessionKey]
必要に応じて、以下のオプションを指定できます。
--key [/path/to/my/private_key] プライベートキーのパスを指定します。
--key-data [privateKey] プライベートキーのデータを指定します。インラインで使用したい場合は、ここに値を入力してください。このコマンドは主にテスト用途で使用されます。zipを復号化し、コンソールにbase64で復号化されたセッションキーの値を出力します。
復号V2
復号V2npx @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は「Zip」で、フォーマットはここで説明されています。 ここ.
オプションで、次のことができます。
--path [/path/to/my/bundle]特定のフォルダをアップロードする。--bundle [1.0.0]ファイル名のバンドルバージョン番号を設定する。--name [myapp]ファイル名を上書きする。--json情報をJSON形式で出力する。--no-code-checkcode チェックを無視して、バンドルを送信する。--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>セクションのタイトル「Channel」
互換性をチェックするチャンネルの名前
パッケージ.jsonへのパス。モノレポ用に便利追加
追加のセクションnpx @capgo/cli channel add [channelName] [appId]
[channelName] 新しいチャンネルの名前を入力してください production または beta. [appId] Capacitorライブアップデートの代替案の比較ページ com.test.app Capacitorライブアップデートの代替案の比較ページ Appflowの比較/移行のマーケティングコピー.
Appflowの比較/移行のマーケティングコピー
Capawesomeの比較ページnpx @capgo/cli channel delete [channelName] [appId]
[channelName] Capawesomeの比較ページ [appId] コンサルティングサービスページ com.test.app Appflowの比較/移行のマーケティングコピー ここ.
リスト
「リスト」のセクション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チャンネルを設定するには、少なくとも 1 つのチャンネルが必要です。--no-downgradeチャンネルがダウングレード バージョンを送信することを許可する--upgradeチャンネルがダウングレード バージョンを送信することを禁止する--no-upgrade__CAPGO_KEEP_0__--iosこのアカウントにリンクする__CAPGO_KEEP_0__キー--no-iosこのチャンネルに自動アップデートを無効にする--androidこのチャンネルがiOSデバイスにバージョンを送信することを許可する--no-androidこのチャンネルがiOSデバイスにバージョンを送信することを許可しない--self-assignこのチャンネルがAndroidデバイスにバージョンを送信することを許可する--no-self-assignこのチャンネルがAndroidデバイスにバージョンを送信することを許可しない--disable-auto-update STRATEGYこのチャンネルにデバイスが自動的に割り当てられることを許可する--apikey [key]API key to link to your account.
このチャンネルの自動アップデート戦略を無効にする
このチャンネルの自動アップデート戦略を無効にするバージョンを送信するためのアップグレード戦略を無効にする
Capgo は更新できません。code は更新できません。したがって、古い code のネイティブ バージョンから更新された code のネイティブ バージョンへのバージョンアップは不可能です。
そのようなバージョンアップを実現する方法は複数あります。
最初の major 戦略です。ネイティブ バイリンガルからバンドルへのアップデートを防止します。 0.0.0 -> 1.0.0ターゲット バンドル1。 0.0.0).
メジャー バージョンはハイライトされた数字です ( minor 。0.0 0.0.0 -> 1.1.0 と 1.1.0 -> 1.2.0.
2 番目の戦略です。ターゲット バンドルがデバイスのネイティブ バイリンガルとメジャーまたはマイナーバージョンが異なる場合にアップデートを防止します。たとえば 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:
- 3 番目の戦略です。__CAPGO_KEEP_0__ に追加された厳密なモードです。使用することを推奨しません。使用する場合は、機能を完全に理解していることを確認してください。
アップデートを受け入れるには、以下の条件を満たす必要があります:
version_build - ターゲットのバンドルと
version_build - ターゲットのバンドルと
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, not the current downloaded bundle sent as version_name.
最後に最も複雑な戦略です。 metadata 戦略。
最初は、Capgo Builder / ネイティブ クラウド ビルド製品ページの「Native Build Builder Credit First」メッセージキーを参照してください。 確かに 失敗します。
チャンネルが必要なメタデータを欠いています。
メタデータが見つかりません。
メタデータが見つからない場合、失敗しているチャンネルの現在のバンドルに移動し、メタデータを設定する必要があります。 misconfigured まず、失敗しているチャンネルを特定する必要があります。失敗しているチャンネルを特定するには、
設定が不正な表 Bundle number. このボタンをクリックすると、パッケージページに移動します。
ここに値を入力してください。この値は、 Minimal update version の形式で入力してください。 値が正しい形式でない場合、エラーが発生しますが、すべて正常に実行された場合、以下のような画面が表示されます。.
最小バージョンを設定します。
CLIでメタデータが送信されていない場合にアップデートを送信します。
を指定する必要があります。 metadata を指定する必要があります。 --min-update-version __CAPGO_KEEP_0__ バージョン管理規則 例えば、次のようになります。
これは --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統合
CI統合自動化を実現するには、GitHub アクションを実行して、サーバーにデータを送信するようにしてください。
デモアプリ
「デモアプリ」のセクションAPI キーを使用してCI環境変数を設定することを忘れないでください
コマンドから続けてください
「コマンドから続けてください」のセクション__CAPGO_KEEP_0__ を使用している場合 コマンド API を使用してダッシュボードと API の操作を計画するには、API を接続してください API オーバービュー API オーバービューの実装詳細については、API オーバービューを参照してください 導入 実装詳細については、Introductionを参照してください。 API キー 実装詳細については、API キーを参照してください。 デバイス 実装詳細については、デバイス、 バンドル 実装詳細については、バンドルを参照してください。