com.<COMPANY NAME>.<APPNAME>、パッケージ ID、およびプロジェクトディレクトリパスに置き換えます<APPNAME>。<projectroot>``amazonを自分の会社名やパッケージIDとして使用しないようにします。
このページでは、Vega CLIコマンドとその例について説明します。
ヘルプとバージョンオプション
インストールされているVega CLIバージョンを出力するには:vega -v.問題を報告する場合はこのバージョンを含めて、CIパイプラインで使用して、ビルドがどのCLIを使用して実行されたかを確認してください。プロジェクトがどのSDKバージョンに対してビルドされているかを確認する場合は、SDKバージョンの管理を参照してください。
すべてのVegaコマンドのオプションを参照するには、次のコマンドを使用します。
vega buildコマンドのすべてのオプションを表示するには:
セットアップコマンド
vega セットアップスタジオ
SDKのインストール中にVega Studio拡張機能をスキップしたときのインストール、または再インストールに使用しますvega setup-studio。このコマンドは現在にはリストされていないためvega --help、このリファレンスを参照してください。
kepler setup-studio形式は同等です。
SDKのインストール中にVega Studioをスキップしてインストールするには:
終了コードとエラー出力
Vega CLIコマンドは、成功すると終了コード00を返し、失敗すると0以外の終了コードを返します。エラーメッセージはstderrstderrに出力されます。
よく使用されるコマンド
以下のコマンドは、アプリのビルド、クリーニング、作成、実行を対象としています。npx react-native build-vega
npx react-native build-vegaコマンドを使用してアプリをコンパイルし、.vpkgファイルを生成します。
アプリをビルドするには、次のコマンドを使用します。
vega clean
<projectroot>/buildフォルダに生成されたアーティファクトを削除するには:
vega project list-templates
サンプルアプリの作成に使用できるJavaScriptテンプレートとターボモジュールテンプレートを表示するには、次のコマンドを使用します。vega project generate
Vegaプロジェクトを作成するには、vega project generate必要なパラメータを指定してコマンドを使用します。
新しいアプリを作成するには、次のコマンドを使用します。
-
vega project generate-Vegaアプリを生成します。 -
--template-コマンドから検索できるVegaアプリまたはTurbo Moduleテンプレートを設定します。vega project list-templatesこの例では、helloWorldテンプレートを使用しています。 -
--name- 新しいアプリまたはターボモジュールの名前です。アプリ名に空白や特殊文字を含めることはできません。<APPNAME>を新しいアプリの任意の名前に置き換えます。 -
--packageId-パッケージ ID を設定しますmanifest.toml。Vegaアプリ用のReact Nativeには必要で、ターボモジュールには必要ありません。<COMPANY NAME>``<APPNAME>会社名とアプリ名に置き換えてください。 -
--outputDir(任意)- 新しいアプリファイルの出力ディレクトリを設定します。<APPNAME>を実際に使用するアプリ名に置き換えます。
vega run-app
アプリをインストールして実行するには、次のコマンドを使用します。-d``--deviceIdの短縮形です。vega device``--deviceコマンドは同じ値に使用されます。
vega run-app``vega device install-app``vega device launch-appこのコマンドはとを組み合わせたものです。アプリ ID はオプションです。省略した場合、コマンドはアプリをインストールしますが、起動しません。
VVDの場合:
sampleappsampleappというアプリをMac Mシリーズコンピューターで実行する場合、コマンドは次のようになります。
プロジェクト互換性コマンド
vega projectvega project互換性コマンドは、アプリがサポートするOSのバージョンを管理します。互換性のあるパッケージバージョンを解決し、プロジェクトをOSバージョンのターゲットに合わせて再調整した後、構成を検証して、マニフェストモジュールエントリを再生成します。[os.version]これらのコマンドの背景となる概念については、ターゲットのOSバージョンを参照してください。各 SDK バージョンがサポートする React Native、OS、およびホストマシンの組み合わせについては、バージョン互換性マトリックスを参照してください。
vega project install
OS@amazon-devices/* バージョン互換のパッケージバージョンを次のように解決するには:package.json
install --fixパッケージをダウンロードしたり、install``node_modulesフォルダを変更したりすることもありません。どちらのコマンドも互換性のあるバージョンを解決し、それらをpackage.jsonpackage.jsonに書き込みます。この2つの形式は範囲が異なります。
-
vega project install <packages..>-すべての互換性チェックに合格した場合、@amazon-devices/*``package.json指定されたパッケージを依存関係としてに追加します。これは新しい依存関係を追加する唯一の形式です。 -
vega project install --fix-@amazon-devices/*package.json既存のすべてのバージョンを互換性マニフェストプロファイルに再配置します。新しいパッケージは追加されません。
--os-versionとを省略すると--rn-version、コマンドはプロジェクトの manifest.toml and package.json からそれらを読み取ります。--fix``--dry-run両方ともデフォルトはオフです。
--os-min``manifest.toml``package.jsonはではなく書き込みを行うオプションの1つで、他のオプションよりも幅が狭くなっています。
-
--fix—fixと併用した場合にのみ有効です。vega project install --fix``install <package>``minベアもランも書き込みません。 -
と一緒に渡してください
--os-version。[os.version]セクションのないプロジェクトでは、installターゲットを解決できないため、Missing OS Version失敗して何も書き込まれません。 -
--os-version``[os.version]セクションのないプロジェクトでは--fix``--os-min、、、installを使用してセクションを作成し、minとを設定しtarget、📝 Set [os.version] min = "<v>" in manifest.tomlで確認します。 -
[os.version]既に存在する場合、minこの形式は書き込みのみで、target変更されません。従来の[os][os]セクションも既存のセクションと見なされます。targettargetを変更するには、vega project update-manifestを使用してください。
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バージョンのターゲットに合わせて調整するには、次のコマンドを使用します。updateupdateは、アプリが既に依存しているパッケージのバージョンについてのみ整合を調整します。各パッケージをOSターゲットと互換性のあるバージョンに更新し、それ以外は変更しません。新しい依存関係を追加するには、vega project installを使用してください。
オプションの指定はすべて任意です。これらを省略すると、コマンドはプロジェクトの and --os-version from --os-min から manifest.toml and --rn-version を読み取りpackage.json、--dry-runデフォルトは off になります。
update``install --fix``@amazon-devices/*両方とも既存のバージョンを互換性マニフェストプロファイルに再配置し、両方ともおよびを受け入れます。package.json --os-version --os-min通常の設定や再配置フローや、[os.version]まだ存在しないセクションの作成に使用しますinstall --fix。変更内容を実際に書き込む前に、レビュー可能な変更プランを確認する場合はupdateupdateを使用します。--dry-run—dry-runにより、各パッケージのバージョンの遷移が出力されるためです。
たとえば、manifest.tomlmanifest.tomlのターゲットに対する再調整をプレビューするには、次のコマンドを使用します。
🔄🔄アイコンは変更されるパッケージを示し、✓✓アイコンは変更されないパッケージを示します。何も変更する必要がないとき、✅ All packages are up to dateコマンドは報告します。
vega project doctor
構成、依存関係、lintルールなど、プロジェクトのOSバージョンの互換性を検証するには、次のコマンドを使用します。doctordoctorは以下の確認を行います。
- SDK互換性マニフェストが存在すること。
- プロジェクト構成が解決されること。
-
[os.version].min``[os.version].targetどちらも有効な OS バージョンです。 -
[os.version].minと等しいかそれ以下です[os.version].target。 -
@amazon-devices/*依存関係のバージョンは互換性マニフェストプロファイルと一致しています。 -
ソースレベルの OS バージョンの lint ルールは
no-unguarded-os-api、、、no-removed-apiおよびに合格します。warn-deprecated-api
no-unguarded-os-apiこのルールは、自分よりも新しい OS バージョンで導入された API を参照するたびにエラーを報告します[os.version].min。参照は、isPresentOnOS()ガードの内側にあるか、// @os-version-okインポートの前の行にコメントがある場合に渡されます。このルールは、import行ではなく、APIを実際に使用している箇所を報告します。no-removed-apiルールは、それ以前に削除された API min への参照のエラーを報告します。warn-deprecated-apiこのルールは、それ以前に廃止された API への参照に関する警告を報告します。[os.version].target
出力の例:
minは1.2、targetです2.0。この後に導入されたすべての API No OS version issues min は保護されているため、lint は報告します。minコードがガードなしで後に導入された API を参照している場合、lint はそのような参照すべてにフラグを立てます。file:line:column rule-idそれぞれを下にインデントしたメッセージと同じように報告し、サマリーはゼロ以外になり❌ 1 check(s) failed.、doctor終了します。
結果では、✅✅アイコンはチェックに合格したことを示し、⚠️⚠️は警告を示し、❌❌は失敗を示します。vega project doctorvega project doctorは、fail severityを持つチェックが1つでも失敗すると0以外の終了コードで終了するため、CIパイプラインのゲートとして使用できます。詳細は、Vega SDKをCIパイプラインに統合する方法を参照してください。
vega project update-manifest
[os.version]に値を設定するにはmanifest.toml:
[os.version]セクション、min``targetつまりおよびの値のみを書き込みます。モジュールエントリは書き込まれません。ビルドでは、から OS バージョンモジュールエントリ (/com.amazon.vega.os@IVega_<v>) [os.version] が生成されます。パッケージエントリとともに、検証マニフェスト、ステージマニフェスト、パッケージマニフェストにそれらを書き込みます。@amazon-devices/*
このコマンドは、実行するたびに、ツールが所有するモジュールエントリもソースから削除します。manifest.tomlこれらには、/com.amazon.vega.os@IVega_*予約済みファミリの OS バージョンモジュールエントリが含まれます。また、バージョン ID @amzn/<pkg>@<version> @amazon-devices/<pkg>@<version> とモジュール ID も含まれます。他のシステムモジュール用に宣言したモジュールエントリは保持されます。以前の SDK で作成されたプロジェクトでは、最初の実行時にソース管理マニフェストからこれらの行が削除されます。この違いは予想通りです。コミットして、エントリを手作業で復元しないでください。
コマンドラインで OS バージョンを渡すときは、
--os-min``--os-versionとを一緒に渡します。両方を省略すると、コマンドはmanifest.tomlからそれらの値を読み取ります。
たとえば、SDK 2.0の推奨設定であるOS 2.0を対象とし、[os.version]それを必要とするプロジェクトにセクションを追加するには:
min``target作成したバージョンとバージョンを報告し、マニフェストから削除したツール所有のモジュールエントリを一覧表示します。
--os-min 1.2パスしてください。選択のヘルプについては、「最小値の選択」を参照してください。
コマンドがツール所有のエントリを削除すると、🧹 Removed tool-owned [[needs.module]]/[[wants.module]] entries from manifest.toml. With も報告され--dry-run、何を書き込んだり削除したりするかを報告し、何も変更しません。マニフェストフィールドの定義とビルドによるモジュールエントリの生成方法については、 Manifest [os.version] セクションを参照してください。needsとwantsの詳細については、マニフェストの[needs]セクションとマニフェストの[wants]セクションを参照してください。
デバイスコマンド
Vega CLIデバイスコマンドインターフェイスは、物理デバイスとVVDを操作する手段を提供します。デバイスコマンドを機能させるには、 Vegaデバイスアダプタ (VDA) をインストールしてパスに追加します。 一般的なコマンド形式は次のとおりです。vega device copy-from
デバイスファイルをホストコンピューターにコピーするには、次のコマンドを使用します。vega device copy-logs
デバイスからアーティファクトファイルを取得するには、次のコマンドを使用します。artifact/provider、--artifact値は次の形式を使用しますsystem/var_log。--dir値は、ファイルをコピーするホストコンピューター上のディレクトリです。
vega device copy-to
ホストファイルをデバイスにコピーするには、次のコマンドを使用します。vega device get-log-info
デバイスからログ情報を取得するには、次のコマンドを使用します。vega device info
デバイスメタデータを JSON 形式で取得するには:vega device install-app
デバイスまたは VVD にアプリをインストールするには、.vpkgパスをで渡します。-pパスは次のパターンに従いますbuild/<ARCH>-<BUILD_TYPE>/<APP_NAME>_<ARCH>.vpkg。
たとえば、Mac x86 sampleapp マシンにインストールするには:
.vpkg.vpkgを自動的に検出してインストールするには、次のコマンドを使用します。
debugビルドタイプを指定するには:
releaseビルドタイプを指定するには:
vega device installed-apps
デバイスにインストールされているアプリの一覧を表示するには、次のコマンドを使用します。vega device installed-packages
デバイスにインストールされているすべてのパッケージの一覧を表示するには、次のコマンドを使用します。vega device is-app-installed
アプリ名を指定してアプリのインストールを確認するには、次のコマンドを使用します。vega device is-app-running
アプリ名を使用してデバイス上でアプリが実行されているかどうかを確認するには:vega device is-connected
特定のデバイスの接続状態を確認するには、次のコマンドを使用します。vega device launch-app
アプリ名を指定してデバイスでアプリを起動するには、次のコマンドを使用します。vega device list
接続されているデバイス(Fire TV StickとVVD)の一覧を表示するには、次のコマンドを使用します。VirtualDevice : tv - architecture - OS type - hostname
次の例は、接続されているFire TVスティック(GXXXXXXXXXXXXXXX)と実行中のVVDを示しています。
出力の例:

