Appium Visual is a VS Code extension for discovering, running, and reviewing Appium JavaScript mobile tests from inside VS Code.
Features
- Detects Appium JavaScript test files in the
e2e/flows/directory. - Shows tests in a dedicated Appium Tests sidebar.
- Starts a local Appium server when needed.
- Detects active Android devices through
adb devices. - Detects booted iOS simulators through
xcrun simctl list devices booted. - Lets you select a default device for test runs.
- Runs one selected test at a time and streams logs to a visual dashboard.
- Supports canceling an active run.
- Shows final status, logs, assertion results, and local artifacts when available.
Requirements
- VS Code desktop.
- Appium server available locally or through a configured server URL.
- Android platform tools for Android device discovery.
- Xcode command line tools on macOS for iOS simulator discovery.
Settings
appiumVisual.appiumServerUrl: Appium server URL.appiumVisual.testDirectory: directory used for Appium environment defaults.appiumVisual.defaultDeviceId: selected device identifier.appiumVisual.defaultDeviceName: display name for the selected Appium device.appiumVisual.artifactRetention: latest run retention mode.
Development
npm install
npm run compile
npm test
Use Run Extension from .vscode/launch.json to start an extension development host.
Troubleshooting
- If Appium is not running, use Appium: Start Appium or set
appiumVisual.appiumServerUrl. - If no Android devices appear, check
adb devices. - If no iOS simulators appear, boot a simulator and check
xcrun simctl list devices booted. - If no tests appear, add
.jsfiles undere2e/flows/and refresh the Appium Tests sidebar.