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 from the command prompt. 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 vega build command:

​
Exit codes and error output

Vega CLI commands return exit code 0 on success and a non-zero exit code on failure. Error messages are written to stderr.

​
Commonly used commands

​
npx react-native build-vega

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

​
vega clean

To remove the artifacts generated in the folder:

​
vega project list-templates

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

​
vega project generate

To create a Vega project, use the vega project generate command with the required parameters. To create a new app:
The following is a breakdown of the different components in the command:
  • vega project generate - Generates a Vega app.
  • --template - Sets the Vega app or Turbo Module template, which you can find from the vega project list-templates command. In the example, it uses the hello-world template.
  • --name - Sets 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 - Sets 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.
  • --outputDir (optional) - Sets 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.

​
vega run-app

To install and run your app:
The following command combines the vega device install-app and vega device launch-app. For the VVD:
For Fire TV:
For example, to run an app called sampleapp 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:

​
vega device copy-from

To copy device files to the host computer:

​
vega device copy-logs

To retrieve the artifact files from a device:

​
vega device copy-to

To copy host files to the device:

​
vega device get-log-info

To retrieve log information from a device:

​
vega device info

To retrieve device metadata in JSON format, including device type, OS version, hostname, architecture, profile, product name, build description, whether the device is simulated or physical, and Developer Mode status:
Example output:

​
vega 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 sampleapp 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:

​
vega 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:

​
vega 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:

​
vega device is-app-installed

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

​
vega 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:

​
vega device is-connected

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

​
vega device launch-app

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

​
vega 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 (GXXXXXXXXXXXXXXX) and a running virtual device:

​
vega device reboot

To reboot the given device:

​
vega device run-cmd

To run a command on a specific device:

​
vega device running-apps

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

​
vega device shell

To start a shell session on a device:

​
vega device start-log-stream

To start streaming logs from a device:

​
vega device stop-log-stream

To stop streaming logs from a device:

​
vega device start-port-forwarding

To start or reverse port forwarding for a device:

​
vega device stop-port-forwarding

To stop or reverse port forwarding for a device:

​
vega device terminate-app

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

​
vega 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

​
vega virtual-device status

To find the status of the virtual device:

​
vega virtual-device start

To start the simulator:
The terminal displays this message:

​
vega virtual-device stop

To stop the simulator:
Last modified on April 3, 2026