コマンド

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

使用方法

あなたのアプリフォルダ内で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キーをローカルリポジトリに保存し、gitignoreします。 医者

「医者」のセクション

npx @capgo/cli doctor

Command to check if you are up-to-date with Capgo packages.

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

アプリ

追加

npx @capgo/cli app add [appId]

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

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

オプションを指定することができます。

• --icon [/path/to/my/icon] カスタムアイコンを表示するために、Capgo ウェブアプリに指定します。
• --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-preview Capacitorライブアップデートの代替品の比較ページ。ロール: マーケティングまたは法的文章。見つける場所: page alternatives.astro。Capgo製品/ブランドと開発者用語をそのまま保存します。
• --allow-device-custom-id または --no-allow-device-custom-id Capacitorライブアップデートの代替品の比較ページ。ロール: マーケティングまたは法的文章。見つける場所: page alternatives.astro。Capgo製品/ブランドと開発者用語をそのまま保存します。
• --block-provider-infra-requests または --no-block-provider-infra-requests Capacitorライブアップデートの代替品の比較ページ。ロール: マーケティングまたは法的文章。見つける場所: page alternatives.astro。Capgo製品/ブランドと開発者用語をそのまま保存します。
• --build-timeout-minutes [5-360] または
• --ios-store-url [url] Capacitorライブアップデートの代替品の比較ページ。ロール: マーケティングまたは法的文章。見つける場所: page alternatives.astro。Capgo製品/ブランドと開発者用語をそのまま保存します。 --android-store-url [url] または
• --default-upload-channel [channel] Capacitorライブアップデートの代替品の比較ページ。ロール: マーケティングまたは法的文章。見つける場所: page alternatives.astro。Capgo製品/ブランドと開発者用語をそのまま保存します。
• --default-download-channel [channel] または --disable-download-channels すべてのダウンロードチャンネルを非公開にする。
• --apikey [key] APIキーをアカウントにリンクする。

リスト

npx @capgo/cli app list [appId]

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

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

• --apikey [key] APIキーをアカウントにリンクする。

削除

npx @capgo/cli app delete [appId]

[appId] アプリIDのフォーマットは 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> - __CAPGO_KEEP_0__を文字列に設定します。
• --bool <true | false> - __CAPGO_KEEP_0__をブール値に設定します。

バンドル

アップロード

npx @capgo/cli bundle upload [appId]

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

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

• --apikey <apikey> API key to link to your account.
• --path <path> リンクするチャンネル名。
• --channel <channel> アプリケーションIDはこちらで説明されています。
• --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をスキップし、バージョンを増分します。前の Capgo バージョンがない場合は、バージョンを増分します。バージョン名が削除された場合も、バージョン名が占有されます。 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> __CAPGO_KEEP_0__
• --auto-min-update-version __CAPGO_KEEP_0__
• --ignore-metadata-check __CAPGO_KEEP_0__
• --ignore-checksum-check __CAPGO_KEEP_0__
• --timeout <timeout> __CAPGO_KEEP_0__
• --delta __CAPGO_KEEP_0__
• --delta-only __CAPGO_KEEP_0__
• --no-delta __CAPGO_KEEP_0__ autoUpdate __CAPGO_KEEP_0__
• --tus __CAPGO_KEEP_0__
• --multipart __CAPGO_KEEP_0__
• --encrypted-checksum <encryptedChecksum> __CAPGO_KEEP_0__
• --package-json <packageJson> A path to package.json. Useful for monorepos.
• --auto-set-bundle capacitor.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に保存された場合、内容を確認しません。

🔑 2層目のセキュリティを追加するには、暗号化を使用できます。 すると、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.

__CAPGO_KEEP_0__キーを付けてアカウントにリンクすることができます。

npx @capgo/cli bundle delete [appId]

[appId] アプリIDのフォーマットについては com.test.app ここで説明されています。 オプションで、.

__CAPGO_KEEP_0__キーを付けてアカウントにリンクすることができます。

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

クリーンアップ

メジャーバージョンを指定して、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] with the version number will only delete this version. 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 __CAPGO_KEEP_0__のバンドル番号を指定しない場合、18バージョンが削除され、最後の2バージョンが残ります。

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

注意

このコマンドは、現在どのチャネルでも使用されているバンドルを無視します。

暗号化

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

このコマンドは、外部のソースで code を保存する場合やテストの目的で使用します。

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

--key [/path/to/my/private_key] プライベートキーのパスを指定します。 --key-data [privateKey] プライベートキーのデータを指定します。インラインで使用する場合にのみ使用します。 コマンドは、y を生成し、エンコードされた zip を出力し、アップロードコマンドまたは復号化コマンドと組み合わせて使用します。 ivSessionKeyEncrypt V2

「Encrypt 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を生成します。

復号

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

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

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

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

復号V2

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

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

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

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] アプリケーションIDは__CAPGO_KEEP_0__です。形式はこちらで説明されています。 ここ. [channelName] チェックするチャンネルの名前です。

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

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

チャンネル

追加

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

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

Capgo

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

[channelName] API [appId] SDK com.test.app CLI ここ.

リスト

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] ここで説明 ここ. [channelName] 指定するチャンネルの名前、例えば production または beta.

オプションで、

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

このチャンネルにデバイスが自動的に割り当てられることを許可しない。

バージョンを送信することを許可する。
Capgo は更新できません。code は更新できません。したがって、古い code のネイティブ バージョンから更新された code のネイティブ バージョンへのバージョンアップは不可能です。 そのようなバージョンアップを実現する方法は複数あります。

第一の戦略です。__CAPGO_KEEP_0__ から __CAPGO_KEEP_1__ への更新を防止します。 major __CAPGO_KEEP_0__ -> __CAPGO_KEEP_1__ 0.0.0 メジャーはハイライトされた数字です (0.0.0 など) 1.0.0第二の戦略です。__CAPGO_KEEP_0__ から __CAPGO_KEEP_1__ への更新を防止します。__CAPGO_KEEP_1__ のターゲット バンドルとデバイスのネイティブ バージョンのメジャーまたはマイナーのどちらかが異なる場合に限ります。1または 0.0.0).
第三の戦略です。__CAPGO_KEEP_0__ から __CAPGO_KEEP_1__ への更新を防止します。これは __CAPGO_KEEP_0__ における厳格なモードとして追加されました。使用することをお勧めしません。使用する場合は、どのように機能するかを完全に理解していることを確認してください。 更新を許可するには、以下の条件が満たされます: minor __CAPGO_KEEP_0__ のターゲット バンドルとデバイスのネイティブ バージョンのメジャーが同じである必要があります 0.0.0 -> 1.1.0 __CAPGO_KEEP_0__ 1.1.0 -> 1.2.0.

__CAPGO_KEEP_1__ 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:

• __CAPGO_KEEP_3__ 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」メッセージキーを参照してください。 しかし、チャンネルが必要なメタデータを欠いているため、更新は失敗します。 チャンネルがメタデータを欠いている場合、次のようなメッセージが表示されます。
メタデータが見つかりません。

まず、失敗しているチャンネルを特定する必要があります。失敗しているチャンネルを特定するには、
列 misconfigured 設定が不正な表

Then go to the failing channel and click on 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コミットしないでください。また、誰かに共有しないでください。

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

アプリ設定でキーを保存

npx @capgo/cli key save

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

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

--key-data [publicKey] パブリックキーをインラインで指定します。このコマンドは、キーをアプリ設定にコミットしなかった場合に便利です。

CI統合

自動化を簡単にするために、GitHub アクションを実行して、サーバーにデータを送信するようにしてください。

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

デモアプリ

GitHub - Cap-go/demo-app

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

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

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