Skip to content
📱 Automation for iOS, Android, and Windows Apps.
JavaScript Java C# Python Ruby PHP
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add lock app to deal with old issues (#12534) Apr 23, 2019
.vscode Add VSCode launch configurations (#10683) May 15, 2018
bin Add function names (#12370) Mar 22, 2019
bundles Release branch pipeline (#12820) Jun 25, 2019
ci-jobs Fix nightly bundle (#12863) Jul 6, 2019
commands-yml docs: update send keys and replace value (#13087) Aug 21, 2019
docs docs: Update generated docs [ci skip] (#13094) Aug 20, 2019
lib fix: stop printing caps twice on session start (#13101) Aug 22, 2019
sample-code sample-code: fix python sample (#13107) Aug 22, 2019
test add --allow-insecure and --deny-insecure server flags Jun 19, 2019
.eslintignore Lint and update JS sample code (#11927) Jan 3, 2019
.eslintrc Add eslint and pre-commit hooks Aug 3, 2016
.gitignore feat: Remove Selendroid driver (#12964) Jul 25, 2019
.npmrc Re-enable package-lock.json (#10660) May 8, 2018
.travis.yml sample-code: fix python sample (#13107) Aug 22, 2019
AUTHORS added myself to the author list Nov 20, 2015
CHANGELOG.md 1.14.1 changelog (#13008) Aug 21, 2019
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 feat: Remove Selendroid driver (#12964) Jul 25, 2019
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
check-npm-pack-files.js Shrinkwrap fixes (#11969) Jan 10, 2019
check-pruned-shrinkwrap.js Check that pruned shrinkwrap has same dependencies as unpruned shrink… Aug 9, 2019
greenkeeper.json Update dependencies to enable Greenkeeper 🌴 (#12105) Jan 31, 2019
gulpfile.js Add function names (#12370) Mar 22, 2019
package.json chore(package): update rimraf to version 3.0.0 (#13076) Aug 14, 2019
packweb.json feat: Remove Selendroid driver (#12964) Jul 25, 2019
triagers.json feat: Remove Selendroid driver (#12964) Jul 25, 2019

README.md

Appium

NPM version Dependency Status devDependency Status

Monthly Downloads

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 more comprehensive 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

You can’t perform that action at this time.