Get the axe DevTools Mobile Appium Drivers

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Add the axe DevTools Mobile drivers into your Appium environment

Not for use with personal data

Requires:

  • Your tests running against Appium version 2.0 or above
  • Deque API Key
  • Use of UiAutomator2 or XCUITest Driver
  • Node.js v.20 or above

First Time Setup

Configure npm for accessing axe DevTools Mobile

The axe DevTools Mobile Appium drivers are available through Deque's Artifactory as an npm package. As such, you'll need to add your credentials to an ~/.npmrc file. Follow our guide for setting up your npm registry to access axe DevTools Mobile.

Install the Drivers

Install the required drivers to your Appium instance through the command line:

axe XCUITest Driver for iOS Testing

Appium 2
appium driver install --source=npm @axe-devtools/axe-appium-xcuitest-driver
Appium 3
appium driver install --source=npm @axe-devtools/axe-appium3-xcuitest-driver

If you need to uninstall at any time, you can uninstall through the command line:

appium driver uninstall axexcuitest

axe UIAutomator2 Driver for Android Testing

Appium 2
appium driver install --source=npm @axe-devtools/axe-appium-uiautomator2-driver
Appium 3
appium driver install --source=npm @axe-devtools/axe-appium3-uiautomator2-driver

If you need to uninstall at any time, you can uninstall through the command line:

appium driver uninstall axeuiautomator2

Optional: Configure iOS Driver for Real Devices

Running Appium tests on real iOS devices requires some additional setup because axe DevTools for Mobile utilizes WebDriverAgent (WDA).

Our WebDriverAgent Xcode project's default path is:\ ~/.appium/node_modules/@axe-devtools/axe-appium-xcuitest-driver/node_modules/@axe-devtools/axe-appium-webdriveragent/WebDriverAgent.xcodeproj.

You can run appium driver run axexcuitest open-wda in the terminal to open the WDA Xcode project.

You can use the XCUITest Driver Real Device Configuration guide from Appium to get started, but keep in mind their default path to WDA is different than ours.

Stay Up to Date

It's important to regularly update the axe DevTools Mobile Appium drivers to ensure you have the latest rules and features. These do not automatically update, so you should check for our new versions periodically. See How to Update axe DevTools Mobile for Appium for details.

What's Next?

Next, you'll set up your automated tests to scan for accessibility issues.

Is this page helpful?

Help us improve this page

Still need help?