Now Available on saucectl
Sauce Runner for Virtual Devices provides the ability to run Espresso tests on Android emulators in the Sauce Labs cloud. This topic describes the required and optional command parameters you can use to set up your test runs.
NOTE: All code examples in this page assume knowledge of Sauce Runner General Usage. Please review before proceeding.
- Your Sauce Labs account credentials.
- Your mobile app file (both debug and non-debug app) and test file.
- Have the Sauce Runner for Real Devices or Sauce Runner for Virtual Devices downloaded and installed to your local machine.
- Prior to using the CLI Reference below, navigate (
cd) to the specific folder directory on your local machine where you downloaded and placed your Sauce Runner file (i.e.,
You can also view the vUSB CLI directly in the command line terminal by running the
These command flags are required in order to run native mobile tests with Sauce Runner on virtual devices.
Description: Specifies the name of the test framework you want to use. At the moment,
espresso is the only supported option and value.
Description: Your Sauce Labs
username. You can use the environment variable
SAUCE_USERNAME to provide your login information. The command line argument will take precedence over the environment variable.
Description: Your Sauce Labs Access Key, which you can find under User Settings in the Sauce Labs interface. You can also use the environment variable SAUCE_ACCESS_KEY to provide your login information. The command line argument will take precedence over the environment variable.
Description: The local path or publicly accessible URL to the location of the application you want to test.
Description: The local path or publicly accessible URL to the location of the test package you want to use.
Description: The type of device you want to use with your test. You can specify two or more device arguments to run tests on multiple devices in parallel, and each device will execute the full test suite. You specify the type of device to use by setting the required
|Yes||The name of the device to use. You can use the Sauce Labs Platform Configurator to look up the Appium |
|Yes||The operating system version of the device you want to use. Supported values depend on the device. You can use the Sauce Labs Platform Configurator to look up the Appium |
|No||Location of the device.|
|No||Orientation of the device. Supported values are: |
Basic Setup (minimum required options only)
Go to our GitHub repository for example scripts, plus demo apps and tests.
These flags provide additional configuration options.
Description: Optional parameters to run a subset of tests. You can provide a test filter to either exclude or include tests. By default, the full test suite is executed.
|Filter one test method|
|Filter two test methods|
|Filter a test class|
|Filter a package|
|Filter by size. Tests should be annotated with |
|Filter by test annotation|
Description: specify a Sauce Connect Proxy tunnel to use with the tests.
Description: specify a Sauce Labs Data Center. Possible values are
Description: skips downloading the JUnit reporting files at the end of test suite execution.
Description: sets the verbosity of console output. Valid options as
Description: returns the version information for Sauce Runner.
Description: prints this command line reference to the console.