Amazon Developer

Console

as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
Ring
AWS
Documentation
Support
Contact Us
My Cases

Console

as

Get Started
Design and Develop
Publish
Reference
Support
Skip to main content
Vega SDK has a command-line interface (CLI) that lets you build apps and run the virtual device in your terminal. When running commands, replace all placeholders with actual values to prevent errors. For example, replace , , and with your app name, company name, and project directory path. Don’t use amazon as your company name or package ID. This page describes the Vega CLI commands and examples.

​
Help option

To explore options for all Vega commands:
To get help for a specific command:
For example, to see all options for kepler build command:

​
Commonly used commands

​
npx react-native build-kepler

Use the npx react-native build-kepler command to compile your app and produce the vpkg. To build an app:

​
kepler clean

To remove the artifacts generated in the folder:

​
kepler project list-templates

To see the available JavaScript and Turbo module templates you can use to create a sample app:
Example output:

​
kepler project generate

To create a Vega project, use the kepler project generate command with the required parameters. To create a new app:
The following is a breakdown of the different components in the command:
  • kepler project generate - Use this command to generate a Vega app.
  • --template - The name of the Vega app or Turbo Module template, which you can find from the kepler project list-templates command. In the example, it uses the hello-world template.
  • --name - The name of your new app or Turbo Module. The name can’t contain whitespace or special characters. Replace with the desired name for your new app.
  • --packageId - The package ID for manifest.toml required in React Native for Vega apps, not in Turbo Module. Replace with the name of your company and with the name of your app. This sets the package ID for the new app.
  • --outputDir (optional) - Specifies the output directory for new app files. Replace with the actual name of your app.
When you follow this format, the command shows the path to your new project.

​
kepler run-kepler

To install and run your app:
The following command combines the kepler device install-app and kepler device launch-app. For the VVD:
For Fire TV:
For example, to run an app called keplersampleapp on a Mac M-series machine, the command is:

​
Device commands

The Vega CLI device command interface provides a way for you to interact with physical devices and the VVD. You must install and make VDA available on the path for device commands to work. The general command format is:
To see all available device commands:

​
kepler device copy-from

To copy device files to the host computer:

​
kepler device copy-logs

To retrieve the artifact files from a device:

​
kepler device copy-to

To copy host files to the device:

​
kepler device get-log-info

To retrieve log information from a device:

​
kepler device install

To install an app on a device and simulator, add arguments for the path (-p) to your app’s package. The path follows this syntax: . For example, if keplersampleapp runs on a Mac x86 machine:
To automatically find the correct .vpkg in the directory and install it:
To specify a debug build type:
To specify a release build type:

​
kepler device installed-apps

To list the apps installed on a device:
For example, to see the list of all apps installed on the virtual device:

​
kepler device installed-packages

To list all packages installed on a device:
For example, to see the list of all packages installed on the virtual device:

​
kepler device is-app-installed

To check for app installation using app name:
To check for app installation using project directory:

​
kepler device is-app-running

To check if an app runs on the device using app name:
To check if an app runs on the device using project directory:

​
kepler device is-connected

To check the connection status of a specific device:
Example:
Output when connected:
Output when not connected:

​
kepler device launch-app

To launch the app on a device using app name:
To launch the app on a device using project directory:

​
kepler device list

To list connected devices (Fire TV Stick and Vega Virtual Device):
The Vega Virtual Device appears as: VirtualDevice : tv - architecture - OS type - hostname Example output with a connected Fire TV Stick (GXX2A1234567890A) and running virtual device:

​
kepler device reboot

To reboot the given device:

​
kepler device run-cmd

To run a command on a specific device:

​
kepler device running-apps

To list all apps running on a device:
For example, to see the list of all apps running on virtual device:

​
kepler device shell

To start a shell session on a device:

​
kepler device start-log-stream

To start streaming logs from a device:

​
kepler device stop-log-stream

To stop streaming logs from a device:

​
kepler device start-port-forwarding

To start or reverse port forwarding for a device:

​
kepler device stop-port-forwarding

To stop or reverse port forwarding for a device:

​
kepler device terminate-app

To terminate an app on a device using app name:
To terminate an app on a device using project directory:
Example:

​
kepler device uninstall-app

To uninstall an app from a device using app name:
To uninstall an app on a device using project directory:
Example:

​
Vega Virtual Device commands

​
kepler virtual-device status

To find the status of the virtual device:

​
kepler virtual-device start

To start the simulator:
The terminal displays this message:

​
kepler virtual-device stop

To stop the simulator:
Last modified on November 11, 2025