📱 Automation for iOS, Android, and Windows Apps.
Switch branches/tags
Clone or download
Permalink
Failed to load latest commit information.
.github Bring Sample Code into master (#10880) Jun 15, 2018
.vscode Add VSCode launch configurations (#10683) May 15, 2018
bin Update linting (#9123) Aug 31, 2017
commands-yml add mobile commands for xcuitest (#11524) Oct 23, 2018
docs Update troubleshooting.md (#11396) Oct 22, 2018
lib Do not use Github API fallback by default (#11506) Oct 10, 2018
sample-code Fix platformVersion in Java sample code (#11356) Sep 12, 2018
test Do not use Github API fallback by default (#11506) Oct 10, 2018
.eslintignore Update linting (#9123) Aug 31, 2017
.eslintrc Add eslint and pre-commit hooks Aug 3, 2016
.gitignore Add csharp sample (#11255) Aug 28, 2018
.npmrc Re-enable package-lock.json (#10660) May 8, 2018
.travis.yml Update appium-gulp-plugins (#11461) Oct 3, 2018
AUTHORS added myself to the author list Nov 20, 2015
CHANGELOG.md 1.9.1 changelog (#11390) Sep 20, 2018
CONDUCT.md Add code of conduct document Nov 20, 2015
CONTRIBUTING.md Update Contributing Docs (#10165) Feb 12, 2018
GOVERNANCE.md Add vmaxim to the list of Appium committers Apr 19, 2018
IDEAS.md add google summer of code ideas doc Feb 8, 2017
LICENSE Update LICENSE to full ASLv2 text Aug 18, 2017
README.md Fix broken links in documentation (#11015) Jul 8, 2018
RELEASE.pdf Copying over release of rights from Zoosk for ios automation code use… Jan 22, 2013
ROADMAP.md Move sample code overhaul to ROADMAP completed list (#11274) Aug 28, 2018
gulpfile.js Update babel for generating docs (#11481) Oct 5, 2018
package.json Bump Espresso past beta (#11563) Oct 23, 2018
packweb.json Remove appium-android-bootstrap from packweb config Sep 17, 2018
triagers.json make triagers list public so we can instruct triager to pull from it May 12, 2017

README.md

Appium

NPM version Dependency Status devDependency Status

Monthly Downloads Pull Requests Issues Closed

Build Status FOSSA Status Greenkeeper badge

Appium is an open source, cross-platform test automation tool for native, hybrid and mobile web and desktop apps. We support simulators (iOS), emulators (Android), and real devices (iOS, Android, Windows, Mac).

Want to skip straight to the action? Check out our getting started doc.

Supported Platforms

Appium supports app automation across a variety of platforms, like iOS, Android, and Windows. Each platform is supported by one or more "drivers", which know how to automate that particular platform. Choose a driver below for specific information about how that driver works and how to set it up:

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 (Node), PHP, Python, Ruby, C#, Clojure, or Perl with the Selenium WebDriver API and language-specific client libraries.
  3. You can use any testing framework.
  4. Appium has built-in mobile web and hybrid app support. Within the same script you can switch seamlessly between native app automation and webview automation, all using the WebDriver model that's already the standard for web automation.

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

For example, if you use Apple's XCUITest library without Appium you can only write tests using Obj-C/Swift, and you can only run tests through Xcode. Similarly, with Google's UiAutomator or Espresso you can only write tests in Java. Appium opens up the possibility of true cross-platform native app automation, for mobile and beyond. Finally!

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 set up for the particular platforms that you want to run tests on. Each of the drivers above documents the requirements for their particular brand of automation. At a minimum, you will need to be able to run Node.js 6+.

Get Started

Check out our Getting Started guide to get going with Appium.

There is also sample code that contains many examples of tests in a variety of different languages!

Documentation

For prettily-rendered docs, please visit appium.io. You can always find the full list of Appium doc pages at Appium's GitHub Repo as well.

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 History, Credits & Inspiration

User Forums

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.

License

FOSSA Status Greenkeeper badge