Install Appium for Vega Integration

​

Prerequisites

1. 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.
2. Use a supported version of Node.js. The Vega Appium Driver supports Node.js 16, 18, 20, and 22. To check your version, run:
   node --version
   
3. Check if you have Appium version 2.2.2 installed.
   appium --version
   
   The output shows your installed Appium version, or an error if Appium is not installed.

4. Uninstall previous versions of Appium.
   npm uninstall -g appium
   
5. Uninstall @appium/types.
   npm uninstall -g @appium/types
   

​

Install Appium

1. Install the Appium Server 2.2.2.
   npm install -g appium@2.2.2
   
2. Verify the Appium version.
   appium --version
   
   The output shows 2.2.2, confirming the correct Appium version is installed.
3. (Optional) Install @appium/types.
   npm install -g @appium/types
   
4. Install the Vega Appium Driver.
   appium driver install --source=npm @amazon-devices/appium-kepler-driver@3.30.0
   
5. Verify the installation of the Vega Appium Driver.
   appium driver list
   
   The output lists the available drivers.
6. Add vda to the global path. The Vega Device Adapter (VDA) command line utility lets you install, test, and debug your Vega app. For Appium to communicate with the Fire TV device or Vega Virtual Device, vda must be on your global PATH. Rather than hardcoding an SDK version, resolve the VDA binary dynamically and add its directory to your PATH. Add this line to your shell profile (~/.zshrc, ~/.bashrc, or equivalent):
   export PATH="$(dirname "$(vega exec which vda)"):$PATH"
   
   Reload your shell:
   source ~/.zshrc
   
   Verify the VDA binary:
   which vda
   
   which vda should resolve to the VDA binary inside your active Vega SDK (for example, .../KeplerCLIVegaDeviceAdaptor-2.0/runtime/bin/vda) rather than the toolbox shim.

​

Next steps

• Set Up Testing with Appium