Vega SDK CLIリファレンス
Vega SDKにはコマンドラインインターフェイス（CLI）があり、ターミナルでアプリをビルドして仮想デバイスを実行できます。コマンドを実行するときは、エラーを防ぐためにすべてのプレースホルダーを実際の値に置き換えます。たとえば、<アプリ名>、<会社名.アプリ名>、<プロジェクトルート>を、実際のアプリ名、会社名、プロジェクトディレクトリのパスに置き換えます。amazonを会社名やパッケージIDとして使用しないでください。
このページでは、Vega CLIコマンドとその例について説明します。
ヘルプオプション
すべてのVegaコマンドのオプションを参照するには、次のコマンドを使用します。
kepler --help
特定のコマンドのヘルプを表示するには、次のコマンドを使用します。
kepler <コマンド> --help
たとえば、kepler buildコマンドのすべてのオプションを確認するには、次のコマンドを使用します。
kepler build --help
よく使用されるコマンド
npm run build:app
npm run build: appコマンドを使用して、アプリのネイティブ部分をコンパイルし、vpkgを生成します。このコマンドは以下の引数を受け取ります。
-t、--target、--targets- アプリをビルドする場所を指定します。使用できるターゲットは、tv、4kmax_g1_vega、sim_tv_x86_64、sim_tv_aarch64です。-b、--build-type、--build-types- アプリをビルドするモードを指定します。指定できるタイプは、DebugとReleaseです。指定しない場合、デフォルトはReleaseになります。
アプリをビルドするには、次のコマンドを使用します。
npm install
npm run build:app
kepler clean
<プロジェクトルート>/buildフォルダに生成されたアーティファクトを削除するには、次のコマンドを使用します。
kepler clean
kepler project list-templates
サンプルアプリの作成に使用できるJavaScriptテンプレートとターボモジュールテンプレートを表示するには、次のコマンドを使用します。
kepler project list-templates
出力の例：
kepler project list-templates
Available templates:
idl-turbo-module: A Turbo Module that's compatible with all supported React Native versions and uses native IDL APIs
hello-world: A Vega app that depends on React Native v0.72
basic-turbo-module: A Turbo Module that's compatible with all supported React Native versions
kepler project generate
Vegaプロジェクトを作成するには、必要なパラメーターを指定してkepler project generateコマンドを使用します。
新しいアプリを作成するには、次のコマンドを使用します。
kepler project generate --template hello-world --name "<アプリ名>" --packageId "com.<会社名>.<アプリ名>" --outputDir "<アプリ名>"
コマンドのさまざまなコンポーネントの詳細は次のとおりです。
-
kepler project generate- このコマンドを使用してVegaアプリを生成します。 -
--template- Vegaアプリやターボモジュールのテンプレート名です。これらはkepler project list-templatesコマンドで確認できます。この例では、hello-worldテンプレートを使用しています。 -
--name- 新しいアプリまたはターボモジュールの名前。アプリ名に空白や特殊文字を含めることはできません。<アプリ名>を新しいアプリの任意の名前に置き換えます。 -
--packageId- Vega向けReact Nativeアプリに必要なmanifest.tomlで使用するパッケージID（ターボモジュール用ではありません）。<会社名>を自分の会社名に置き換え、<アプリ名>を自分のアプリ名に置き換えます。これにより、新しいアプリのパッケージIDが設定されます。 -
--outputDir（省略可能）- 新しいアプリファイルの出力ディレクトリを指定します。<アプリ名>を自分のアプリ名に置き換えます。
このフォーマットに従うと、コマンドによって、新しいプロジェクトへのパスが表示されます。
kepler run-kepler
アプリをインストールして実行するには：
kepler run-kepler <Vpkgのパス> <アプリID> -d <デバイス>
以下のコマンドは、kepler device install-appコマンドとkepler device launch-appコマンドを組み合わせたものです。
VVDの場合：
kepler run-kepler <Vpkgのパス> <アプリID> -d VirtualDevice
Fire TVの場合：
kepler run-kepler <Vpkgのパス> <アプリID> -d <DSN>
たとえば、keplersampleappというアプリをMac Mシリーズコンピューターで実行するには、次のコマンドを実行します。
kepler run-kepler build/x86_64-release/keplersampleapp_aarch64.vpkg com.amazondeveloper.keplersampleapp.main -d VirtualDevice
デバイスコマンド
Vega CLIデバイスコマンドインターフェイスは、物理デバイスとVVDを操作する手段を提供します。デバイスコマンドを機能させるには、VDAをインストールしてパスで使用できるようにする必要があります。
一般的なコマンド形式は次のとおりです。
kepler device <コマンド> [パラメーター]
使用可能なすべてのデバイスコマンドを表示するには、次のコマンドを使用します。
kepler device --help
kepler device copy-from
デバイスファイルをホストコンピューターにコピーするには、次のコマンドを使用します。
kepler device copy-from --device <デバイス名> --source <ファイルまたはディレクトリ> --destination <ファイルまたはディレクトリ>
kepler device copy-logs
デバイスからアーティファクトファイルを取得するには、次のコマンドを使用します。
kepler device copy-logs --device <デバイス名> --artifact <アーティファクト名> --directory <ファイルのディレクトリ>
kepler device copy-to
ホストファイルをデバイスにコピーするには、次のコマンドを使用します。
kepler device copy-to --device <デバイス名> --source <ファイルまたはディレクトリ> --destination <ファイルまたはディレクトリ>
kepler device get-log-info
デバイスからログ情報を取得するには、次のコマンドを使用します。
kepler device get-log-info --device <デバイス名>
kepler device install
デバイスやシミュレーターにアプリをインストールするには、アプリのパッケージのパスを引数（-p）として追加します。このパスは、build/<アーキテクチャ>-<ビルドタイプ>/<アプリ名>_<アーキテクチャ>.vpkgという構文に従います。
たとえば、keplersampleappがMac x86コンピューターで実行される場合、次のコマンドを使用します。
kepler device install-app -p build/x86_64-release/keplersampleapp_x86_64.vpkg --device <デバイス名>
ディレクトリ内の適切な.vpkgを自動的に検出してインストールするには、次のコマンドを使用します。
kepler device install-app --dir .
ビルドタイプとしてdebugを指定するには、次のコマンドを使用します。
kepler device install-app --dir . -b Debug
ビルドタイプとしてreleaseを指定するには、次のコマンドを使用します。
kepler device install-app --dir . -b Release
kepler device installed-apps
デバイスにインストールされているアプリの一覧を表示するには、次のコマンドを使用します。
kepler device installed-apps --device <デバイス名>
たとえば、仮想デバイスにインストールされているすべてのアプリの一覧を表示するには、次のコマンドを使用します。
kepler device installed-apps --device VirtualDevice
kepler device installed-packages
デバイスにインストールされているすべてのパッケージの一覧を表示するには、次のコマンドを使用します。
kepler device installed-packages --device <デバイス名>
たとえば、仮想デバイスにインストールされているすべてのパッケージの一覧を表示するには、次のコマンドを使用します。
kepler device installed-packages --device VirtualDevice
kepler device is-app-installed
アプリ名を指定してアプリのインストールを確認するには、次のコマンドを使用します。
kepler device is-app-installed --device <デバイス名> --appName <アプリ名>
プロジェクトディレクトリを指定してアプリのインストールを確認するには、次のコマンドを使用します。
kepler device is-app-installed --device <デバイス名> --directory <プロジェクトディレクトリ>
kepler device is-app-running
アプリ名を指定してデバイス上でアプリが実行されているかどうかを確認するには、次のコマンドを使用します。
kepler device is-app-running --device <デバイス名> --appName <アプリ名>
プロジェクトディレクトリを指定してデバイス上でアプリが実行されているかどうかを確認するには、次のコマンドを使用します。
kepler device is-app-running --device <デバイス名> --directory <プロジェクトディレクトリ>
kepler device is-connected
特定のデバイスの接続状態を確認するには、次のコマンドを使用します。
kepler device is-connected --device <デバイス名>
例：
kepler device is-connected --device GXX2A1234567890A
接続しているときの出力：
Device GXX2A1234567890A is connected
接続していないときの出力：
Device GXX2A1234567890A is not connected
kepler device launch-app
アプリ名を指定してデバイスでアプリを起動するには、次のコマンドを使用します。
kepler device launch-app --device <デバイス名> --appName <アプリ名>
プロジェクトディレクトリを指定してデバイス上でアプリを起動するには、次のコマンドを使用します。
kepler device launch-app --device <デバイス名> --directory <プロジェクトディレクトリ>
kepler device list
接続されているデバイス（Fire TV StickとVega仮想デバイス）の一覧を表示するには、次のコマンドを使用します。
kepler device list
Vega仮想デバイスは次のように表示されます。 VirtualDevice : tv - architecture - OS type - hostname
以下は、Fire TV Stick（GXX2A1234567890A）を接続し、仮想デバイスを実行している場合の出力例です。
GXX2A1234567890A : A1ZZ32RVTQ796E
VirtualDevice : tv - x86_64 - OS - amazon-ab123456cd789012
kepler device reboot
特定のデバイスを再起動するには、次のコマンドを使用します。
kepler device reboot --device <デバイス名>
kepler device run-cmd
特定のデバイスでコマンドを実行するには、次のコマンドを使用します。
kepler device run-cmd --device <デバイス名> --command '<実行するコマンド>'
kepler device running-apps
デバイスで実行されているすべてのアプリの一覧を表示するには、次のコマンドを使用します。
kepler device running-apps --device <デバイス名>
たとえば、仮想デバイスで実行されているすべてのアプリの一覧を表示するには、次のコマンドを使用します。
kepler device running-apps --device VirtualDevice
kepler device shell
デバイスでシェルセッションを開始するには、次のコマンドを使用します。
kepler device shell --device <デバイス名>
kepler device start-log-stream
デバイスからのログのストリーミングを開始するには、次のコマンドを使用します。
kepler device start-log-stream --device <デバイス名>
kepler device stop-log-stream
デバイスからのログのストリーミングを停止するには、次のコマンドを使用します。
kepler device stop-log-stream --device <デバイス名>
kepler device start-port-forwarding
デバイスで順方向または逆方向のポートフォワーディングを開始するには、次のコマンドを使用します。
kepler device start-port-forwarding --device <デバイス名> --port <ポート番号> --forward <true|false>
kepler device stop-port-forwarding
デバイスで順方向または逆方向のポートフォワーディングを停止するには、次のコマンドを使用します。
kepler device stop-port-forwarding --device <デバイス名> --port <ポート番号> --forward <true|false>
kepler device terminate-app
アプリ名を指定してデバイス上のアプリを終了するには、次のコマンドを使用します。
kepler device terminate-app --device <デバイス名> --appName <アプリ名>
プロジェクトディレクトリを指定してデバイス上でアプリを終了するには、次のコマンドを使用します。
kepler device terminate-app --device <デバイス名> --directory <プロジェクトディレクトリ>
例：
kepler device terminate-app --appName com.amazondeveloper.keplersampleapp.main --device VirtualDevice
// 出力
Force stopping pkg: com.amazondeveloper.keplersampleapp
kepler device uninstall-app
アプリ名を指定してデバイスからアプリをアンインストールするには、次のコマンドを使用します。
kepler device uninstall-app --device <デバイス名> --appName <アプリ名>
プロジェクトディレクトリを指定してデバイス上のアプリをアンインストールするには、次のコマンドを使用します。
kepler device uninstall-app --device <デバイス名> --appName <アプリ名> --directory <プロジェクトディレクトリ>
例：
kepler device uninstall-app --appName com.amazondeveloper.keplersampleapp.main --device VirtualDevice
// 出力
Uninstalling 'com.amazondeveloper.keplersampleapp' ...success
Vega仮想デバイスコマンド
kepler virtual-device status
仮想デバイスの状態を確認するには、次のコマンドを使用します。
kepler virtual-device status
kepler virtual-device start
シミュレーターを起動するには、次のコマンドを使用します。
kepler virtual-device start
ターミナルに次のメッセージが表示されます。
Launching default instance.
Waiting for virtual device to boot.
Launch process complete.
Virtual device shell available.
Virtual device ready.
kepler virtual-device stop
シミュレーターを停止するには、次のコマンドを使用します。
kepler virtual-device stop
関連トピック
Last updated: 2025年10月2日
