Install Appium for Vega Integration

Open Beta Documentation Amazon offers this technical documentation as part of a pre-release, open beta. The features described might change as Amazon receives feedback and iterates on the features. For the most current feature information, see the Release Notes.

The Vega SDK supports Appium, a third-party test automation framework for native, mobile, and hybrid apps. With Appium, you can perform user interface (UI) test automation at different testing levels, which includes integration tests, end-to-end tests, and functional tests.

This page provides steps to install Appium for Vega integration.

Prerequisites

Before you begin, you must:

Install the Vega SDK.

The Vega SDK includes the Vega Appium driver and the Vega Virtual Device. For installation instructions, see Install the Vega SDK.
Check if you have Appium version 2.2.2 installed.
Copied to clipboard.
```
 appium --version
```
Tip: Proceed to Install Appium if this is your first install.
Uninstall previous versions of Appium.
Copied to clipboard.
```
 npm uninstall -g appium
```
Uninstall @appium/types.
Copied to clipboard.
```
 npm uninstall -g @appium/types
```

Install Appium

To install Appium and its required components for Vega integration, complete the following steps.

Install the Appium Server 2.2.2.
Copied to clipboard.
```
 npm install -g appium@2.2.2
```
Verify the Appium version.
Copied to clipboard.
```
 appium --version
```
(Optional) Install @appium/types.
Copied to clipboard.
```
 npm install -g @appium/types
```
Tip: Install @appium/types only if you encounter any type-related errors.

Install the Vega Appium Driver 3.30.0

Copied to clipboard.

 appium driver install --source=npm @amazon-devices/appium-kepler-driver@3.30.0

Verify the installation of Vega Appium Driver.
Copied to clipboard.
```
 appium driver list
```
The output lists the available drivers.

You must add vda to the global path for Appium to communicate with the Fire TV device or Vega Virtual Device. Follow the instructions in SDK installation to add vda to the global path.

Last updated: Sep 30, 2025