Skip to content
:iphone: Automation for iOS and Android Apps. http://appium.io/
JavaScript Java Shell Batchfile HTML AppleScript
Find file
Latest commit 54c2b4e @penguinho penguinho Merge pull request #6037 from pra85/2016
Update year range to 2016
Failed to load latest commit information.
assets Add test support for iOS 8.4
bin issue/kill spawn process ios_webkit_debug_proxy
ci moved jenkins-tools to jenkins-gulper
docs updated homebrew location in docs
lib rm old.apk --> rm -f old.apk
submodules update selendroid to 0.17.0 release
test Updated tests, fixed mocha grep string
.gitignore get rid of old xpath/uiauto dirs now that we have appium-uiauto
.gitmodules ci fixes, moved appium-ci-gulper to appium-ci/jenkins-tools
.jscsrc adds Android api 18 to new ci
.jshintignore adds Android api 18 to new ci
.jshintrc disabling shelljs in jshint
.npmignore move all android-related files together into devices/android
AUTHORS add self to authors, fix spelling
CHANGELOG.md Bumping to 1.4.16 and updating changelog
CONDUCT.md move conduct page and link from CONTRIBUTING
CONTRIBUTING.md add notice about our CLA
Gruntfile.js Moving linting and unit tests to gulp, they can still be called via g…
LICENSE Update year range to 2016
README.md add roadmap doc and link from readme
RELEASE.pdf Copying over release of rights from Zoosk for ios automation code use…
ROADMAP.md fix typo
grunt-helpers.js Fix building of selendroid
gulpfile.js ci fix
install-beta.md added appium beta install doc
install-from-npm.md added install from npm doc
npm-shrinkwrap.json Bumping to 1.4.16 and updating changelog
package.json updated websocket dependency to resolve remote memory disclosure
packweb.json update packweb with new module
reset.bat move sample code and apps out of main repo
reset.sh added --ignore-shrinkwrap option to reset.sh
trigger.txt testing jenkins build trigger

README.md

Appium

NPM version Dependency Status devDependency Status

Monthly Downloads Pull Requests Issues Closed

Build Status

Appium is an open source, cross-platform test automation tool for native, hybrid and mobile web apps, tested on simulators (iOS, FirefoxOS), emulators (Android), and real devices (iOS, Android, FirefoxOS).

Supported Platforms

  • iOS
  • Android
  • FirefoxOS

See the platform support doc for more detailed information.

Why Appium?

  1. You don't have to recompile your app or modify it in any way, due to use of standard automation APIs on all platforms.
  2. You can write tests with your favorite dev tools using any WebDriver-compatible language such as Java, Objective-C, JavaScript with Node.js (in promise, callback or generator flavors), PHP, Python, Ruby, C#, Clojure, or Perl with the Selenium WebDriver API and language-specific client libraries.
  3. You can use any testing framework.

Investing in the WebDriver protocol means you are betting on a single, free and open protocol for testing that has become a defacto standard. Don't lock yourself into a proprietary stack.

If you use Apple's UIAutomation library without Appium you can only write tests using JavaScript and you can only run tests through the Instruments application. Similarly, with Google's UiAutomator you can only write tests in Java. Appium opens up the possibility of true cross-platform native mobile automation. Finally!

I don't get it yet...

If you're new to Appium, or want a fuller description of what this is all about, please read our Introduction to Appium Concepts.

Requirements

Your environment needs to be setup for the particular mobile platforms that you want to run tests on. See below for particular platform requirements.

If you want to run Appium via an npm install, hack with or contribute to Appium, you will need node.js and npm 0.10 or greater (use n or brew install node to install Node.js. Make sure you have not installed Node or Appium with sudo, otherwise you'll run into problems). We recommend the latest stable version.

To verify that all of Appium's dependencies are met you can use appium-doctor. Run appium-doctor and supply the --ios or --android flags to verify that all of the dependencies are set up correctly. If running from source, you may have to use ./bin/appium-doctor.js or node bin/appium-doctor.js.

You also need to download the Appium client for your language so you can write tests. The Appium clients are simple extensions to the WebDriver clients. You can see the list of clients and links to download instructions at the Appium clients list.

iOS Requirements

Android Requirements

  • Android SDK API >= 17 (Additional features require 18/19)
  • Appium supports Android on OS X, Linux and Windows. Make sure you follow the directions for setting up your environment properly for testing on different OSes:

FirefoxOS Requirements

Quick Start

Kick up an Appium server, and then run a test written in your favorite WebDriver-compatible language! You can run an Appium server using node.js or using the application, see below.

Using Node.js

$ npm install -g appium
$ appium &

Using the App

Writing Tests for Appium

The main guide for getting started writing and running tests is the running tests doc, which includes explanations for iOS, Android, and Android older devices. If you're interested in testing on physical hardware, you might be interested in our real devices guide.

Essentially, we support a subset of the Selenium WebDriver JSON Wire Protocol, and extend it so that you can specify mobile-targeted desired capabilities to run your test through Appium.

You find elements by using a subset of WebDriver's element-finding strategies. See finding elements for detailed information. We also have several extensions to the JSON Wire Protocol for automating mobile gestures like tap, flick, and swipe.

You can also automate web views in hybrid apps! See the hybrid app guide

This repository contains many examples of tests in a variety of different languages!

For the full list of Appium doc pages, visit this directory.

How It Works

Appium drives various native automation frameworks and provides an API based on Selenium's WebDriver JSON wire protocol.

Appium drives Apple's UIAutomation library for iOS support, which is based on Dan Cuellar's work on iOS Auto.

Android support uses the UiAutomator framework for newer platforms and Selendroid for older Android platforms.

FirefoxOS support leverages Marionette, an automation driver that is compatible with WebDriver and is used to automate Gecko-based platforms.

Contributing

Please take a look at our contribution documentation for instructions on how to build, test and run Appium from source.

Roadmap

Interested in where Appium is heading in the future? Check out the Roadmap

Project Credits & Inspiration

Credits

Mailing List

Announcements and debates often take place on the Discussion Group, be sure to sign up!

Troubleshooting

We put together a troubleshooting guide. Please have a look here first if you run into any problems. It contains instructions for checking a lot of common errors and how to get in touch with the community if you're stumped.

Using Robots

Using Appium with Tapster and other robots is possible, check out the Appium Robots project!

Something went wrong with that request. Please try again.