Automation for Apps.
Want to see pretty graphs? Log in now!
npm install appium
|356||downloads in the last day|
|1 281||downloads in the last week|
|6 183||downloads in the last month|
|Last Published By|
|Version||0.18.2 last updated 8 hours ago|
|Dependencies (46)||underscore, colors, express, grunt, grunt-cli, argparse, path, rimraf, uuid-js, temp, winston, request, bplist-parser, plist, bufferpack, bplist-creator, node-uuid, underscore.string, glob, unzip, ncp, swig, async, mkdirp, xml2js, difflib, prompt, binary-cookies, namp, node-idevice, win-spawn, adm-zip, ws, socket.io, md5calculator, through, date-utils, bytes, appium-atoms, appium-instruments, appium-uiauto, mv, js2xmlparser2, xpath, xmldom, sandboxed-module|
|Dependents||dalek-browser-ios, dalek-browser-ios-canary, screen.object|
permalink: /getting-started.html layout: default title: Getting started
description: Want to rock your mobile app automation? This is how you get started!
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).
See the platform support doc for more detailed information.
- You don't have to recompile your app or modify it in any way, due to use of standard automation APIs on all platforms.
- 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.
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.
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.8 or greater (
brew install node: make sure you have not installed Node or Appium with
sudo, otherwise you'll likely run into problems). We recommend the latest stable version.
To verify that all of Appium's dependencies are met you can use
appium-doctor and supply the
--android flags to verify that all
of the dependencies are set up correctly. If running from source, you may have to use
- Mac OS X 10.7 or higher, 10.8.4 recommended
- XCode >= 4.6.3
- Apple Developer Tools (iPhone simulator SDK, command line tools)
- Ensure you read our documentation on setting yourself up for iOS testing!
- Android SDK API >= 17 (Additional features require 18)
- 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:
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.
$ npm install -g appium $ appium &
Using the App
- Download the Appium app
- Run it!
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.
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.
Please take a look at our contribution documentation for instructions on how to build, test and run Appium from source.
Project Credits & Inspiration
Announcements and debates often take place on the Discussion Group, be sure to sign up!
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.