コマンド

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

使用法

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

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

Init

npx @capgo/cli@latest init [apikey]

このメソッドは、ステップバイステップでアカウントをセットアップするために使用されます。

It will add your app to Capgo. It will add the code to your app to validate the update. Likewise, it will build your app. Furthermore, it will upload your app to Capgo. And it will help you to check if the update works.

Login

npx @capgo/cli login [apikey]

Login apikey あなたのために。

注意

use --apikey=******** 任意のコマンドを上書きするには

任意のオプションを指定できます

--local このコマンドは、ローカルリポジトリにあなたの APIキー を保存し、gitignoreで無視します。

ドクター

npx @capgo/cli doctor

このコマンドは、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] セクション "設定" here.

ここ

• --icon [/path/to/my/icon] Capgo ウェブアプリにカスタムアイコンを表示する
• --name [test] カスタム アイコンを表示するウェブ アプリにします。
• --retention [retention] リスト内のカスタム名を表示します。
• --expose-metadata [true|false] アプリ バンドルの保持期間 (日数)、 0 (デフォルト) = 無限です。
• --preview or --no-preview または
• --allow-device-custom-id or --no-allow-device-custom-id カスタムデバイスIDを制御する
• --block-provider-infra-requests or --no-block-provider-infra-requests GoogleとAppleのデータセンターの要求をブロックする
• --build-timeout-minutes [5-360] ネイティブビルドのタイムアウトを設定する
• --ios-store-url [url] or --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 ここで説明されています。 ここ.

オプションで、以下の情報を入力できます:

• --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> オプション:
• --bool <true | false> - 設定を真偽値に設定します。

バンドル

アップロード

npx @capgo/cli bundle upload [appId]

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

あなたは以下のいずれかを指定することができます。

• --apikey <apikey> API キーを指定して、あなたのアカウントにリンクします。
• --path <path> アップロードするフォルダのパス
• --channel <channel> リンクするチャンネル
• --external <url> Capgo Cloud へのアップロードではなく、外部 URL にリンクする
• --iv-session-key <key> バンドルURL外部のIVとセッションキーを設定します。
• --s3-endpoint <s3Endpoint> URLはS3エンドポイントです。デリタアップロードや外部オプションと組み合わせると機能しません。
• --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> アップロードするバンドルに含まれるバンドルバージョン番号を指定します。
• --auto-bump [level] チャンネルの関連付けられたバンドルから自動的にインクリメントする、またはリモートアプリの最新バージョンを使用します。レベル: major, minor デフォルト patch alias fix), metadata、 ai ワーカーAIは、ローカルファイルを前のCapgo/チャンネルデルタマニフェストと比較し、レベルを推測し、短い理由をログし、AIをスキップし、 patch レベルが指定されていない場合は、前のCapgoバージョンが存在しない場合は、バージョンを増分します。バージョン名が空いているものまで増分します。削除されたバージョン名は占有されます。このオプションは、 --bundle.
• --min-update-version <minUpdateVersion> このバージョンにアップグレードするために必要な最小バージョンを指定します。このオプションは、チャンネルのメタデータで自動アップデートを無効に設定されている場合にのみ使用されます。
• --auto-min-update-version native パッケージに基づいて最小のアップデートバージョンを設定します。
• --ignore-metadata-check アップロード時にメタデータ (node_modules) チェックを無視します。
• --ignore-checksum-check アップロード時にチェックサム チェックを無視します。
• --timeout <timeout> アップロードプロセスのタイムアウト (秒)。
• --delta Delta (マニフェスト) ファイルとフル バンドルを一緒にアップロードします。
• --delta-only フル バンドルのアップロードをスキップし、Delta (マニフェスト) のみアップロードします。
• --no-delta Disable Delta (manifest) Uploads (useful if an instant apply) autoUpdate tus プロトコルを使用してバンドルをアップロードします。
• --tus バンドルをtusプロトコルでアップロードします。
• --multipart 外部バンドルのアップロード時にのみ使用される暗号化されたチェックサム (署名)。
• --encrypted-checksum <encryptedChecksum> パッケージ.json のパス。モノレポ用に便利です。
• --package-json <packageJson> package.json のパス。モノレポ用に便利です。
• --auto-set-bundle capacitorの設定ファイルを更新します。
• --node-modules <nodeModules> モノレポ用のnode_modulesのパスの一覧です。 (コンマで区切って例: ../../node_modules,./node_modules)

⭐️ 外部オプションは、2つのケースを解放します: 企業のプライバシー懸念、3rdパーティにcodeを送信しない、または200MBを超えるアプリ。 この設定では、Capgoはzipへのリンクのみを保存し、すべてのアプリにリンクを送信します。

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

🔑 2層目のセキュリティを追加することで、Capgoが内容を確認または変更できなくなります。これは「信頼できない」状態になります。

例 package.json バージョン

{
  "version": "1.0.2"
}

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

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

リスト

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 ここで説明されています ここ.

オプションとして、

• --apikey [key] API キーをアカウントにリンクすることができます。
• --bundle バージョン番号が付いた場合、このバージョンだけを削除します。

クリーンアップ

メジャーバージョンをCloudに送信するためのSemVer範囲

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

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

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

• --apikey [key] API キーをクリックしてアカウントにリンクします。
• --bundle [majorVersion] 削除したいパッケージの数 (デフォルト 4) を指定できます。 numberToKeep.
• --keep [numberToKeep] 例えば、10.0.1 から 10.0.11 までの 10 バージョンがあり、

バージョン 10.0.5 を削除したい場合、前のパッケージの最後のバージョン 10.0.4 と、 npx @capgo/cli cleanup [appId] --bundle=10.0.0 10.0.1 から 10.0.6 を削除します。 10.0.7 から 10.0.11 は残されます。

合計 20 バージョンが存在し、バンドル番号を指定しない場合: 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] プライベートキーのデータを指定します。インラインで使用する場合。 ivSessionKeyyとエンコードされたzipを生成し、アップロードコマンドまたは復号化コマンドで使用します。

エンコードV2

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

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

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

--key [/path/to/my/private_key] プライベートキーのパスを指定します。 --key-data [privateKey] プライベートキーのデータを指定します。インラインで使用する場合。 --json 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は、ここで説明されている形式になります ここ.

オプションで、次のことができます

• --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] Capacitorライブアップデートの代替案の比較ページの長いマーケティングまたは法的文章 com.test.app Appflowの比較/移行マーケティングコピーの長いマーケティングまたは法的文章 here.

Delete

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

[channelName] アプリIDのフォーマットはこちらで説明されています。 [appId] Capacitorライブアップデートの代替案の比較ページの長いマーケティングまたは法的文章 com.test.app Appflowの比較/移行マーケティングコピーの長いマーケティングまたは法的文章 here.

リスト

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

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

古いバージョンに対して更新を無効にする方法は複数あります。
Capgoはcodeを更新できません。したがって、古いcodeのcodeに更新されたcodeの__CAPGO_KEEP_4__に更新することはできません。 そのような更新を実現する方法は複数あります。

最初は、 major 戦略です。 0.0.0 -> ターゲット バンドル 1.0.0。メジャーはハイライトされた数字1。0.0 0.0.0).
と minor 戦略です。 0.0.0 -> 1.1.0 or 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-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 column

メタデータが見つからない場合、 Bundle number次のようになります。チャンネルが失敗しているかどうかを調べるには、

そこに値を入力してください。この値はsemverでなければなりません。 Minimal update version 値がsemverでない場合、エラーが発生しますが、すべてが正常に動作すれば、次のようなメッセージが表示されます。 最小バージョンを設定する.
更新を毎回手動で設定するのは面倒です。幸いにも、__CAPGO_KEEP_0__はこのメタデータが存在しない場合にアップデートを送信しないようにします。

Now, you likely do not want to set this data manually every time you update. Fortunately, the CLI will prevent you from sending an update without this metadata

__CAPGO_KEEP_2__は、有効なsemverでなければなりません。 metadata __CAPGO_KEEP_0__ --min-update-version __CAPGO_KEEP_1__ __CAPGO_KEEP_2__日本語

The --min-update-version その --auto-min-update-versionは、互換性のための方法の唯一の方法ではありません。 また、

も存在します。 以下はそのしくみです。 bundle compatibility 最初に、チャンネルにアップロードされているバージョンを確認します。 それが min_update_version コマンドと同じ互換性のチェックを行います。 2番目に、新しいバージョンが完全に互換性がある場合、最新のバージョンから 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 環境変数を設定するのを忘れないでください

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

あなたが「Commands」を使用している場合 コマンド 計画ダッシュボードとAPI オペレーションを実行するために API オーバーヴィュー API オーバーヴィュー Introduction 導入については「Introduction」 API キー API キーに関する実装詳細のため デバイス デバイス バンドル バンドル