コマンド

使用方法

capacitorプロジェクトを適切に起動している場合、すべてのコマンドはアプリフォルダ内で実行してください。

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

初期化

npx @capgo/cli@latest init [apikey]

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

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

ログイン

npx @capgo/cli login [apikey]

__CAPGO_KEEP_0__を使用してあなたの apikey あなたの

注意

コマンドの任意の場所で使用してください。 --apikey=******** オプションで指定することができます。

__CAPGO_KEEP_0__をローカルリポジトリに保存し、gitで無視します。

--local apikey ドクター 医療用途

任意のコマンドで使用してください

npx @capgo/cli doctor

最新の Capgo パッケージとアップデートされているかどうかを確認するコマンド

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

アプリ

追加

npx @capgo/cli app add [appId]

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

オプションを指定する場合は、以下のいずれかを選択できます。

your app ID the format

• --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です。形式についてはこちらで説明しています。 ここ.

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

• --icon [/path/to/my/icon] Capgoのカスタムアイコンを表示するにはWebアプリをご利用ください。
• --name [test] リスト内のカスタム名を表示するには
• --retention [retention] アプリパッケージの保存期間（日数）、0を指定すると無限期
• --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] アプリ ID の形式 com.test.app はここで説明されています ここ.

Optionally, you can give:

• --apikey [key] API key をアカウントにリンクするために使用します。
• --bundle バージョン番号を付けて、指定したバージョンだけを削除します。

デバッグ

npx @capgo/cli app debug [appId]

[appId] アプリ ID の形式 com.test.app はここで説明されています ここ.

Optionally, you can give:

• --apikey [key] APIキーを使用して、自分のアカウントにリンクすることができます。
• --device with the specific device you want to debug

設定

npx @capgo/cli app setting [path]

Capacitor設定を編集します。

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

__CAPGO_KEEP_0__を指定する必要があります。 --string または --bool!

Options:

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

Bundle

Upload

npx @capgo/cli bundle upload [appId]

[appId] アプリIDはこちらの形式で指定します ここで説明します.

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

• --apikey <apikey> API
• --path <path> __CAPGO_KEEP_0__フォルダへのアップロードパスです。
• --channel <channel> __CAPGO_KEEP_0__チャンネルへのリンクです。
• --external <url> Capgoへのアップロードではなく、外部URLへのリンクを設定します。
• --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 と root フォルダ内のインデックスが存在する場合、notifyAppReady() が呼び出されたかどうかを確認しないでください。
• --display-iv-session コンソールに使用された暗号化更新の IV とセッション キーを表示します。
• --bundle <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 Multipart プロトコルを使用して S3 へのデータのアップロードに使用します。 (使用不可)。
• --multipart 外部バンドルのアップロード時に使用される暗号化されたチェックサム (署名)。
• --encrypted-checksum <encryptedChecksum> package.json のパス。モノレポ用に便利です。
• --package-json <packageJson> config.json にバンドルを設定します。
• --auto-set-bundle Set the bundle in capacitor.config.json.
• --node-modules <nodeModules> ⭐️ 外部オプションは、2 つのケースを解放します: 企業のプライバシー懸念、__CAPGO_KEEP_0__ を 3 番目のパーティーに送信しないこと、または 200 MB を超えるアプリ。 この設定では、__CAPGO_KEEP_1__ は ZIP のリンクのみを保存し、すべてのアプリにリンクを送信します。

⭐️ 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 に保存されている場合には、クラウドは何も見ることができません。

🔑 セキュリティの2層目として暗号化を使用することができます。すると、Capgo は何も見ることができなくなり、または変更することができなくなり、 “信頼できない”状態になります。

例として package.json バージョン

{
  "version": "1.0.2"
}

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

💡 バージョン番号を毎回更新することを忘れないでください。バージョン番号は、削除された後は再利用できず、または上書きできません。

リスト

npx @capgo/cli bundle list [appId]

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

Optionally, you can give:

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

削除

npx @capgo/cli bundle delete [appId]

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

オプションで、

• --apikey [key] API keyを使用してアカウントにリンクする
• --bundle バージョン番号を含めて指定すると、このバージョンだけが削除されます。

クリーンアップ

__CAPGO_KEEP_0__

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

[appId] Cloud com.test.app is explained here.

Optionally, you can give:

• --apikey [key] API key to link to your account.
• --bundle [majorVersion] a version you wish to remove previous packages for, it will keep the last one + numberToKeep.
• --keep [numberToKeep] the number of packages you wish to keep (default 4).

For example: If you have 10 versions from 10.0.1 to 10.0.11, and you use npx @capgo/cli cleanup [appId] --bundle=10.0.0 it will remove 10.0.1 to 10.0.6. 10.0.7 until 10.0.11 will be kept.

If you have 20 versions in total, and you don’t provide a bundle number like this: npx @capgo/cli cleanup [appId] --keep=2 It will remove 18 versions, and keep the last 2.

このコマンドは確認を求めます、使用するテーブルは何を保持し、削除するかを示します。

注意

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

暗号化

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

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

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

--key [/path/to/my/private_key] プライベートキーのパスを指定します。 --key-data [privateKey] プライベートキーのデータを指定します。インラインで使用する場合。コマンドはプライベートキーのデータを表示します。 ivSessionKeyと__CAPGO_KEEP_0__を使用する場合、またはテスト目的の場合に使用します。

Encrypt V2

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

このコマンドは、codeを外部のソースで保存する場合、またはテスト目的の場合に使用します。 ファイルの整合性を検証するために使用されるチェックサムは、bundleを生成するために使用される—key-v2によって生成されます。 チェックサムは、暗号化されたファイルとともに、プライベートキーで暗号化されます。 暗号化v2では、チェックサムはbundleの「署名」にアップグレードされます。

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

--key [/path/to/my/private_key] プライベートキーのパスを指定します。 --key-data [privateKey] プライベートキーデータを指定します。インラインで使用する場合。 --json JSON形式で情報を出力します。 ivSessionKeyコマンドは次の情報を表示します。

と__CAPGO_KEEP_0__を使用する場合、またはテスト目的の場合に使用します。

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

「Decrypt」のセクション

--key [/path/to/my/private_key] __CAPGO_KEEP_0__

--key-data [privateKey] __CAPGO_KEEP_0__

__CAPGO_KEEP_1__

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

__CAPGO_KEEP_3__

--key [/path/to/my/private_key] __CAPGO_KEEP_4__ --key-data [privateKey] __CAPGO_KEEP_5__ --checksum [checksum] __CAPGO_KEEP_6__

__CAPGO_KEEP_7__

npx @capgo/cli bundle zip [appId]

[appId] __CAPGO_KEEP_9__ __CAPGO_KEEP_10__.

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

• --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)。

チャンネル

追加

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

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

削除

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

[channelName] 削除したいチャンネルの名前を入力してください。 [appId] あなたのアプリIDの形式 com.test.app はこちらで説明されています ここ.

リスト

npx @capgo/cli channel list [appId]

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

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

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

設定

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 iOS用のバージョンを送信することができます
• --ios iOS用のバージョンを送信することはできません
• --no-ios Android用のバージョンを送信することができます
• --android iOS用のバージョンを送信することはできません
• --no-android Android デバイスにバージョンを送信することを禁止します。
• --self-assign このチャネルに割り当てられるデバイスが自動的に割り当てられます。
• --no-self-assign このチャネルに割り当てられたデバイスが自動的に割り当てられないようにします。
• --disable-auto-update STRATEGY このチャネルの自動更新戦略を無効にします。可能なオプションは次のとおりです：メジャー、メイン、パッチ、メタデータ、なし。
• --apikey [key] APIキーを使用してアカウントにリンクします。

更新戦略を無効にします。

__CAPGO_KEEP_0__は__CAPGO_KEEP_1__を更新できません。したがって、古い__CAPGO_KEEP_2__のネイティブ__CAPGO_KEEP_0__から最新の__CAPGO_KEEP_3__のネイティブ__CAPGO_KEEP_1__へのアップデートは不可能です。 そのためには、以下の方法があります。
Capgo cannot update native code thus an update from a version with the old native code to a version with the updated native code should not be possible. There are a couple of ways to achieve that.

更新戦略。ネイティブの基準線からターゲットのバンドルへの更新を防ぎます。 major -> ターゲット バンドルへ更新することはできないようにします。 0.0.0 更新戦略を無効にする方法 1.0.0. The major is the highlighted number (1.0.0 and 0.0.0).
Second is the minor strategy. It prevents an update when the target bundle has a different major or minor than the device native baseline, such as 0.0.0 -> 1.1.0 or 1.1.0 -> 1.2.0.

Third, the 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
• The major is the same between the target bundle and version_build
• The minor is the same between the target bundle and version_build
• The patch is the same between the target bundle and-beta.2Only the version suffix may differ, such as prerelease (+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 __CAPGO_KEEP_0__

失敗しているチャンネルを探す Bundle number失敗しているチャンネルを探す

失敗しているチャンネルを探す Minimal update version 失敗しているチャンネルを探す semver.
値がsemverでない場合、エラーが発生しますが、すべて正常に進んだ場合、次のようなものを確認できます。

Capgoの更新を毎回手動で設定したくない場合、幸いにもCLIはこのメタデータを送信しない更新を防ぐように設計されています

Capacitorを使用してバンドルを適切にアップロードするには、 metadata optionを使用する場合、 --min-update-version に の有効なsemverを渡す必要があります。

__CAPGO_KEEP_0__ メタデータ付きのアップロードです。 --min-update-version は、互換性のための唯一の方法ではありません。 互換性のある方法もあります。 --auto-min-update-versionはどのように機能するかを説明します。

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

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

Min update version

Min update version not compatible

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

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

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

暗号化スキーマ

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

npx @capgo/cli key create

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

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

アプリのconfigファイルにキーを保存する

npx @capgo/cli key save

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

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

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

CI統合

作業を自動化するには、GitHub アクションを推論サーバにキーをプッシュするようにすることをお勧めします。

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

デモアプリ

GitHub - Cap-go/demo-app

CI環境変数にAPI キーを設定することを忘れないでください。

Commandsから続ける

あなたがCommandsを使用している場合 Commands Commandsを使用してダッシュボードとAPIの操作を計画している場合、APIの概要と接続してください APIの概要 APIの概要の実装詳細については、APIの概要を参照してください Introduction Introductionの実装詳細については、Introductionを参照してください APIのキー APIのキーについての実装詳細については、APIのキーを参照してください デバイス __CAPGO_KEEP_0__の実装詳細については、デバイスのページを参照してください。 __CAPGO_KEEP_0__ __CAPGO_KEEP_1__ページを編集します。