Skip to main content

Appium Quickstart

Appium is an automation testing framework that allows you to write tests using the Selenium syntax that are for use in testing native, mobile web, and hybrid apps on iOS and Android devices. Run your Appium tests on Sauce Labs to benefit from speed, parallelization, clear test result history, failure analysis, issue tracking, and more.

  • Don't have Appium tests but want to try? The Appium Demo Repo includes a sample project structure, working configuration specifications, and sample Java tests so you can get up and running in less than 10 minutes using the Quickstart instructions on this page!
  • Already have Appium tests to run? Take advantage of the Sauce Labs library of real devices, emulators and simulators, and OS/browser combinations to maximize your digital confidence on every version of every device.

What You'll Need#

The following list of prerequisites are specific to running tests written in Java, per this demonstration. For information about other supported languages, refer to the demo projects in the Sauce Labs Training Repo.

Step 1: Check out the Sample Project#

The Appium Quickstart for Java demo repo contains all the project files necessary to execute a test against a mobile app or a web app accessed through a mobile browser. Clone the project in your local environment to get started.

git clone

Step 2: Link your Sauce Labs Account#

Set your SAUCE_USERNAME and SAUCE_ACCESS_KEY as environment variables to avoid having to enter them with each command and to protect them from exposure in your tests.

Step 3: Upload the App#

Download the iOS version of the Swag Labs App and upload it to your Sauce Labs account. You can do this through the Sauce Labs UI or by calling the API.

  • Sauce Labs UI: From the Sauce Labs Live Testing page, select App Upload and select the file.

  • API: Use the Upload File to App Storage API request to upload the sample app to your account.

    curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" --location \--request POST '' \--form 'payload=@"/Users/lindsaywalker/Git/Example_Tests/"' \--form 'name=""'

Step 4: Run the Tests#

You can run the test from a terminal on your machine or from within your IDE.

Terminal Command
mvn clean test

Alternatively, you can right click the test and choose Run from most IDE interfaces.

Following this quickstart, you should be able to see the results of your test in Sauce Labs.