Vega SDK CLIリファレンス

Vega SDKにはコマンドラインインターフェイス（CLI）があり、コマンドプロンプトからアプリをビルドしてVega仮想デバイス（VVD）を実行できます。コマンドを実行するときは、エラーを防ぐためにすべてのプレースホルダーを実際の値に置き換えます。たとえば、<アプリ名>、<会社名.アプリ名>、<プロジェクトルート>を、実際のアプリ名、会社名、プロジェクトディレクトリのパスに置き換えます。amazonを会社名やパッケージIDとして使用しないでください。

このページでは、Vega CLIコマンドとその例について説明します。

ヘルプとバージョンオプション

インストールされているVega CLIバージョンを出力するには：

vega --version

短縮形はvega -vです。問題を報告する場合はこのバージョンを含めて、CIパイプラインで使用して、ビルドがどのCLIを使用して実行されたかを確認してください。プロジェクトがどのSDKバージョンに対してビルドされているかを確認する場合は、SDKバージョンの管理を参照してください。

すべてのVegaコマンドのオプションを参照するには、次のコマンドを使用します。

vega --help

特定のコマンドのヘルプを表示するには、次のコマンドを使用します。

vega <コマンド> --help

たとえば、vega buildコマンドのすべてのオプションを確認するには、次のコマンドを使用します。

vega build --help

終了コードとエラー出力

Vega CLIコマンドは、成功すると終了コード0を返し、失敗すると0以外の終了コードを返します。エラーメッセージはstderrに出力されます。

よく使用されるコマンド

npx react-native build-vega

npx react-native build-vegaコマンドを使用してアプリをコンパイルし、vpkgを生成します。

アプリをビルドするには、次のコマンドを使用します。

npm install
npx react-native build-vega

vega clean

<プロジェクトルート>/buildフォルダに生成されたアーティファクトを削除するには、次のコマンドを使用します。

vega clean

vega project list-templates

サンプルアプリの作成に使用できるJavaScriptテンプレートとターボモジュールテンプレートを表示するには、次のコマンドを使用します。

vega project list-templates

出力の例：

vega project list-templates

Available templates:
helloWorld: Use this project template to create a new app (targets RN v0.83)
helloWorld-rn72: Use this project template to create a new app (targets RN v0.72)
basic-turbo-module: An example Turbo Module that includes stubs for calling your own native logic.
idl-turbo-module: An example Turbo Module that uses native OS APIs defined in IDL
vegaWebview: A webview template for Vega apps

vega project generate

Vegaプロジェクトを作成するには、必要なパラメーターを指定してvega project generateコマンドを使用します。

新しいアプリを作成するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega project generate --template helloWorld --name "<アプリ名>" --packageId "com.<会社名>.<アプリ名>" --outputDir "<アプリ名>"

コマンドのさまざまなコンポーネントの詳細は次のとおりです。

• vega project generate - Vegaアプリを生成します。

• --template - Vegaアプリまたはターボモジュールのテンプレートを設定します。テンプレートはvega project list-templatesコマンドで確認できます。この例では、helloWorldテンプレートを使用しています。

• --name - 新しいアプリまたはターボモジュールの名前を設定します。アプリ名に空白や特殊文字を含めることはできません。<アプリ名>を新しいアプリの任意の名前に置き換えます。

• --packageId - Vega向けReact Nativeアプリに必要なmanifest.tomlに指定するパッケージIDを設定します。ターボモジュールでは必要ありません。<会社名>を自分の会社名に置き換え、<アプリ名>を自分のアプリ名に置き換えます。

• --outputDir（任意）- 新しいアプリファイルの出力ディレクトリを設定します。<アプリ名>を自分のアプリ名に置き換えます。

このフォーマットに従うと、コマンドによって、新しいプロジェクトへのパスが表示されます。

vega run-app

アプリをインストールして実行するには、次のコマンドを使用します。

vega run-app <VPKGのパス> <アプリID> -d <デバイス>

以下のコマンドは、vega device install-appコマンドとvega device launch-appコマンドを組み合わせたものです。

VVDの場合：

コードをコピー クリップボードにコピーしました。

vega run-app <VPKGのパス> <アプリID> -d VirtualDevice

Fire TVの場合：

コードをコピー クリップボードにコピーしました。

vega run-app <VPKGのパス> <アプリID> -d <DSN>

たとえば、sampleappというアプリをMac Mシリーズコンピューターで実行する場合、コマンドは次のようになります。

コードをコピー クリップボードにコピーしました。

vega run-app build/aarch64-release/sampleapp_aarch64.vpkg com.amazondeveloper.sampleapp.main -d VirtualDevice

プロジェクト互換性コマンド

vega project互換性コマンドは、アプリがサポートするOSのバージョンを管理します。互換性のあるパッケージバージョンを解決し、プロジェクトをOSバージョンのターゲットに合わせて再調整した後、構成を検証して、マニフェストモジュールエントリを再生成します。これらのコマンドの背景となる概念については、ターゲットのOSバージョンを参照してください。

vega project install

OSバージョンと互換性のある@amazon-devices/*パッケージのバージョンをpackage.jsonに解決するには：

vega project install [パッケージ..] [オプション]

installとinstall --fixはいずれも、パッケージをダウンロードしたり、node_modulesフォルダを変更したりしません。どちらのコマンドも互換性のあるバージョンを解決し、それらをpackage.jsonに書き込みます。この2つの形式は範囲が異なります。

• vega project install <パッケージ..> - すべての互換性チェックに合格した場合、指定された@amazon-devices/*パッケージを依存関係としてpackage.jsonに書き込みます。これは新しい依存関係を追加する唯一の形式です。

• vega project install --fix - package.json内の既存のすべての@amazon-devices/*のバージョンを互換性プロファイルに合わせて調整します。新しいパッケージは追加されません。

オプションの指定はすべて任意です。--os-versionや--rn-versionを省略すると、コマンドはプロジェクトのmanifest.tomlとpackage.jsonからこれらの値を読み取ります。--fixと--dry-runはどちらもデフォルトでオフになっています。

--os-minは、package.jsonではなくmanifest.tomlに書き込む唯一のオプションであり、ほかのオプションよりも適用範囲が限定されています。

• --fixと併用した場合にのみ有効です。単独のvega project install --fixやinstall <パッケージ>コマンドでは、minは書き込まれません。

• --os-versionと併用してください。[os.version]セクションがないプロジェクトでは、installはターゲットを解決できないため、Missing OS Versionで失敗し、何も書き込みません。

• [os.version]セクションがないプロジェクトで両方のフラグを指定した場合、installはこのセクションを作成し、minの設定、targetの初期化を行い、📝 Set [os.version] min = "<v>" in manifest.tomlと表示して確認します。

• 既に[os.version]が存在する場合、この形式はminのみを書き込み、targetは変更しません。従来の[os]セクションも既存のセクションと見なされます。targetを変更するには、vega project update-manifestを使用してください。

たとえば、プロジェクト内のOS提供パッケージすべての整合性を再調整するには、次のコマンドを使用します。

vega project install --fix

出力の例：

📦 Installed packages for OS Version 1.2 + RN 0.72

Packages:
  📦 @amazon-devices/kepler-file-system@1.2.0 (fixed)
  ✓ @amazon-devices/kepler-camera@1.0.0 (current)

💡 Next steps:
  • npm install — Install the updated dependencies
  • vega project doctor — Validate OS version compatibility
  • Build your app (npx react-native build-vega or your build script)

任意ですが、後でvega project doctorを実行することをお勧めします。install --fixはバージョンを解決し、doctorはその結果を検証してソースレベルのOSバージョンlintを実行します。詳細については、vega project doctorを参照してください。

--dry-runを指定すると、コマンドは変更を書き込まずに解決内容をプレビューし、ヘッダーは🔍 Dry run — no changes will be madeになります。

vega project update

プロジェクトのnpmパッケージとマニフェストをOSバージョンのターゲットに合わせて調整するには、次のコマンドを使用します。

vega project update [オプション]

updateは、アプリが既に依存しているパッケージのバージョンについてのみ整合を調整します。各パッケージをOSターゲットと互換性のあるバージョンに更新し、それ以外は変更しません。新しい依存関係を追加するには、vega project installを使用してください。

オプションの指定はすべて任意です。オプションを省略すると、このコマンドは--os-version、--os-min、--rn-versionの値をプロジェクトのmanifest.tomlから読み取ります。また、--dry-runはデフォルトでオフになります。

updateとinstall --fixはいずれもpackage.json内の既存の@amazon-devices/*バージョンを互換性プロファイルに合わせて調整し、どちらも--os-versionと--os-minを受け入れます。通常のセットアップや再調整フロー、まだ存在しない[os.version]セクションの作成には、install --fixを使用します。変更内容を実際に書き込む前に、レビュー可能な変更プランを確認する場合はupdateを使用します。--dry-runにより、各パッケージのバージョンの遷移が出力されるためです。

たとえば、manifest.tomlのターゲットに対する再調整をプレビューするには、次のコマンドを使用します。

vega project update --dry-run

出力の例：

📋 Update plan for OS Version 1.2 + RN 0.72:

  🔄 @amazon-devices/kepler-file-system (1.1.0 → 1.2.0)
  ✓ @amazon-devices/kepler-camera (1.2.0)
  ✓ @amazon-devices/kepler-lifecycle (1.2.0)

1 package(s) to update.

🔍 Dry run — no changes applied.Run without --dry-run to apply.

プランでは、🔄アイコンは変更されるパッケージを示し、✓アイコンは変更されないパッケージを示します。何も変更する必要がない場合、このコマンドは✅ All packages are up to dateを出力します。

vega project doctor

構成、依存関係、lintルールなど、プロジェクトのOSバージョンの互換性を検証するには、次のコマンドを使用します。

vega project doctor [オプション]

オプションの指定はすべて任意です。オプションを省略すると、コマンドはプロジェクトから値を読み取ります。オプションを指定するのは、プロジェクトで既に設定されている内容をオーバーライドする場合だけです。

doctorは以下の確認を行います。

• SDK互換性マニフェストが存在すること。

• プロジェクト構成が解決されること。

• [os.version].minと[os.version].targetがいずれも有効な、正式に定義されたOSバージョンであること。

• [os.version].minが[os.version].target以下であること。

• @amazon-devices/*依存関係のバージョンがSDKプロファイルと一致していること。

• OSバージョンモジュールのエントリはmanifest.tomlにあること。

• ソースレベルのOSバージョンのlintルール（no-unguarded-os-api）に合格していること。

no-unguarded-os-apiルールは、[os.version].minよりも新しいOSバージョンで導入されたAPIへの各参照にフラグを立てます。参照がisPresentOnOS()のガード内にある場合、またはそのimportの直前の行に// @os-version-okコメントが付いている場合は、チェックを通過します。このルールは、import行ではなく、APIを実際に使用している箇所を報告します。

出力の例：

🩺 Project Doctor

  ✅ OS versions valid: min=1.2, target=1.2
  ✅ os.min ≤ os.target: 1.2 ≤ 1.2
  ✅ Dependencies: All 5 packages match manifest
  ✅ needs.module at os.min: All needs available at os.min
  ✅ OS version lint: No OS version issues

✅ All critical checks passed.

Vega SDK 0.24の時点で正式に定義されているOSバージョンはOS 1.2のみであるため、minとtargetはどちらも1.2です。min以降は何も導入されず、ガードする対象が何もなかったため、lintはNo OS version issuesを報告します。より新しいOSバージョンが正式に作成され、minをtargetより小さい値に設定すると、lintはminの後に導入されたAPIへのガードされていないすべての参照にフラグを立てます。各フラグはfile:line:column rule-idの形式で報告され、その下にメッセージがインデントして表示されます。概要は❌ 1 check(s) failed.となり、doctorは0以外の終了コードで終了します。

結果では、✅アイコンはチェックに合格したことを示し、⚠️は警告を示し、❌は失敗を示します。vega project doctorは、fail severityを持つチェックが1つでも失敗すると0以外の終了コードで終了するため、CIパイプラインのゲートとして使用できます。詳細は、Vega SDKをCIパイプラインに統合する方法を参照してください。

vega project update-manifest

manifest.toml内のOSバージョンモジュールのエントリを、[os.version]の構成内容から再生成するには、次のコマンドを使用します。

vega project update-manifest [オプション]

このコマンドは、OSバージョンのエントリのみを書き込みます。ビルドによって再生成される@amazon-devices/*パッケージのエントリは書き込まれません。このコマンドが書き込むエントリは次のとおりです。

• [os.version].min用に1つの[[needs.module]]エントリ。形式は/com.amazon.vega.os@IVega_<min>です。アプリはminより前のバージョンのOSのデバイスにはインストールされません。

• minより上で、[os.version].targetまでの各OSバージョン用にそれぞれ1つの[[wants.module]]エントリ。形式は/com.amazon.vega.os@IVega_<v>です。minとtargetが同じである場合、wantsは生成されません。

コマンドラインでOSバージョンを指定する場合は、--os-minと--os-versionを必ずセットで指定してください。minはneedsとして扱われるモジュールを決定し、targetはwantsの上限を決定します。この2つの組み合わせによって、生成されるモジュールエントリが決まります。両方を省略すると、コマンドはmanifest.tomlからそれらの値を読み取ります。どちらか1つだけを指定しないでください。

たとえば、OS 1.2をターゲットとするプロジェクトのモジュールエントリを生成するには、次のコマンドを使用します。

vega project update-manifest --os-min 1.2 --os-version 1.2

出力の例：

📋 OS Version: min=1.2, target=1.2
   OS-version modules: 1 need (at min), 0 wants (up to target)

✅ Updated manifest.toml with the [os.version] block and 1 need.Your @amazon-devices/* package entries are regenerated when you build.

--dry-runを指定すると、コマンドは生成されたTOMLを書き込む代わりに出力します。マニフェストのフィールド定義については、マニフェストの[os.version]セクションを参照してください。needsとwantsの詳細については、マニフェストの[needs]セクションとマニフェストの[wants]セクションを参照してください。

デバイスコマンド

Vega CLIデバイスコマンドインターフェイスは、物理デバイスとVVDを操作する手段を提供します。デバイスコマンドを機能させるには、VDAをインストールしてパスで使用できるようにする必要があります。

一般的なコマンド形式は次のとおりです。

vega device <コマンド> [パラメーター]

使用可能なすべてのデバイスコマンドを表示するには、次のコマンドを使用します。

vega device --help

vega device copy-from

デバイスファイルをホストコンピューターにコピーするには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device copy-from --device <デバイスのシリアル番号> --source <ファイルまたはディレクトリ> --destination <ファイルまたはディレクトリ>

vega device copy-logs

デバイスからアーティファクトファイルを取得するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device copy-logs --device <デバイス名> --artifact <アーティファクト名> --directory <ファイルのディレクトリ>

vega device copy-to

ホストファイルをデバイスにコピーするには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device copy-to --device <デバイス名> --source <ファイルまたはディレクトリ> --destination <ファイルまたはディレクトリ>

vega device get-log-info

デバイスからログ情報を取得するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device get-log-info --device <デバイス名>

vega device info

デバイスのメタデータをJSON形式で取得するには、次のコマンドを使用します。返される結果には、デバイスタイプ、OSバージョン、ホスト名、アーキテクチャ、プロファイル、製品名、ビルドの説明、デバイスがシミュレートされているか物理デバイスか、開発者モードのステータスが含まれます。

コードをコピー クリップボードにコピーしました。

vega device info --device <デバイス名>

出力の例：

{
  "idme": "ABCDEFG999999",
  "os": "OS",
  "hostname": "hostname",
  "architecture": "aarch64",
  "profile": "tv",
  "product": "vvrp-tv-arm64",
  "buildDescription": "OS 1.2",
  "simulated": true,
  "inDeveloperMode": true
}

vega device install-app

デバイスやVVDにアプリをインストールするには、アプリのパッケージのパスを引数（-p）として追加します。このパスは、build/<アーキテクチャ>-<ビルドタイプ>/<アプリ名>_<アーキテクチャ>.vpkgという構文に従います。

たとえば、Mac x86コンピューターで動作するsampleappの場合、コマンドは次のようになります。

コードをコピー クリップボードにコピーしました。

vega device install-app -p build/x86_64-release/sampleapp_x86_64.vpkg --device <デバイス名>

ディレクトリ内の適切な.vpkgを自動的に検出してインストールするには、次のコマンドを使用します。

vega device install-app --dir .

ビルドタイプとしてdebugを指定するには、次のコマンドを使用します。

vega device install-app --dir . -b Debug

ビルドタイプとしてreleaseを指定するには、次のコマンドを使用します。

vega device install-app --dir . -b Release

vega device installed-apps

デバイスにインストールされているアプリの一覧を表示するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device installed-apps --device <デバイス名>

たとえば、VVDにインストールされているすべてのアプリの一覧を表示するには、次のコマンドを使用します。

vega device installed-apps --device VirtualDevice

vega device installed-packages

デバイスにインストールされているすべてのパッケージの一覧を表示するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device installed-packages --device <デバイス名>

たとえば、VVDにインストールされているすべてのパッケージの一覧を表示するには、次のコマンドを使用します。

vega device installed-packages --device VirtualDevice

vega device is-app-installed

アプリ名を指定してアプリのインストールを確認するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device is-app-installed --device <デバイス名> --appName <アプリ名> 

プロジェクトディレクトリを指定してアプリのインストールを確認するには、次のコマンドを使用します。

vega device is-app-installed --device <デバイス名> --directory <プロジェクトディレクトリ>

vega device is-app-running

アプリ名を指定してデバイス上でアプリが実行されているかどうかを確認するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device is-app-running --device <デバイス名> --appName <アプリ名> 

プロジェクトディレクトリを指定してデバイス上でアプリが実行されているかどうかを確認するには、次のコマンドを使用します。

vega device is-app-running --device <デバイス名> --directory <プロジェクトディレクトリ>

vega device is-connected

特定のデバイスの接続状態を確認するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device is-connected --device <デバイス名>

例：

vega device is-connected --device GXX2A1234567890A

接続しているときの出力：

Device GXX2A1234567890A is connected

接続していないときの出力：

Device GXX2A1234567890A is not connected

vega device launch-app

アプリ名を指定してデバイスでアプリを起動するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device launch-app --device <デバイス名> --appName <アプリ名> 

プロジェクトディレクトリを指定してデバイス上でアプリを起動するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device launch-app --device <デバイス名> --directory <プロジェクトディレクトリ>

vega device list

接続されているデバイス（Fire TV StickとVVD）の一覧を表示するには、次のコマンドを使用します。

vega device list

VVDは次のように表示されます。 VirtualDevice : tv - architecture - OS type - hostname

以下は、Fire TV Stick（GXXXXXXXXXXXXXXX）を接続し、VVDを実行している場合の出力例です。

GXXXXXXXXXXXXXXX : A1ZZ32RVTQ796E 
VirtualDevice : tv - x86_64 - OS - yourhostname

vega device reboot

特定のデバイスを再起動するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device reboot --device <デバイス名>

vega device run-cmd

特定のデバイスでコマンドを実行するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device run-cmd --device <デバイス名> --command '<実行するコマンド>'

vega device running-apps

デバイスで実行されているすべてのアプリの一覧を表示するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device running-apps --device <デバイス名>

たとえば、VVDで実行されているすべてのアプリの一覧を表示するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device running-apps --device VirtualDevice

vega device shell

デバイスでシェルセッションを開始するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device shell --device <デバイス名>

vega device start-log-stream

デバイスからのログのストリーミングを開始するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device start-log-stream --device <デバイス名>

vega device stop-log-stream

デバイスからのログのストリーミングを停止するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device stop-log-stream --device <デバイス名>

vega device start-port-forwarding

デバイスで順方向または逆方向のポートフォワーディングを開始するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device start-port-forwarding --device <デバイス名> --port <ポート番号> --forward <true|false>

vega device stop-port-forwarding

デバイスで順方向または逆方向のポートフォワーディングを停止するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device stop-port-forwarding --device <デバイス名> --port <ポート番号> --forward <true|false>

vega device terminate-app

アプリ名を指定してデバイス上のアプリを終了するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device terminate-app --device <デバイス名> --appName <アプリ名> 

プロジェクトディレクトリを指定してデバイス上でアプリを終了するには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device terminate-app --device <デバイス名> --directory <プロジェクトディレクトリ>

例：

vega device terminate-app --appName com.amazondeveloper.sampleapp.main --device VirtualDevice

// 出力 
Force stopping pkg: com.amazondeveloper.sampleapp

vega device uninstall-app

アプリ名を指定してデバイスからアプリをアンインストールするには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device uninstall-app --device <デバイス名> --appName <アプリ名> 

プロジェクトディレクトリを指定してデバイス上のアプリをアンインストールするには、次のコマンドを使用します。

コードをコピー クリップボードにコピーしました。

vega device uninstall-app --device <デバイス名> --appName <アプリ名> --directory <プロジェクトディレクトリ>

例：

vega device uninstall-app --appName com.amazondeveloper.sampleapp.main --device VirtualDevice

// 出力
Uninstalling 'com.amazondeveloper.sampleapp' ...success 

Vega仮想デバイスコマンド

vega virtual-device status

VVDの状態を確認するには、次のコマンドを使用します。

vega virtual-device status

vega virtual-device start

VVDを起動するには、次のコマンドを使用します。

vega virtual-device start

ターミナルに次のメッセージが表示されます。

Launching virtual device.
Waiting for virtual device to boot.
Virtual device ready.

vega virtual-device stop

VVDを停止するには、次のコマンドを使用します。

vega virtual-device stop

関連トピック

• Vega拡張機能とCLIに関する問題の解決
• Vega Studioのコマンド

Last updated: 2026年8月19日