webdriverio-workflo/docs/guide/services/appium.md

This is a customized version of webdriverio for use with workflo framework.

name: Appium
category: services
tags: guide
index: 3
title: WebdriverIO - Appium Service
---

Webdriver.io service plugin for Appium
======================================

[webdriver.io](http://webdriver.io/) service plugin for [Appium](http://appium.io/).  With this service installed, you need not to run Appium manually.

## Installation

The easiest way is to keep `wdio-appium-service` as a devDependency in your `package.json`.

```json
{
  "devDependencies": {
    "wdio-appium-service": "~0.2.2"
  }
}
```

You can this simply by adding it with:

```bash
npm install wdio-appium-service --save-dev
```

## How to Use

Please register this package as service plugin and specify command line arguments in [wdio.conf](http://webdriver.io/guide/getstarted/configuration.html).  `'appium'` is used for command.  If `command` key is provided in the configuration, it will be used.

```javascript
{
  ... // Other config

  services: ['appium'],

  appium: {
    args: {
      address: '127.0.0.1',
      commandTimeout: '7200',
      sessionOverride: true,
      debugLogSpacing: true,
      platformVersion: '9.1',
      platformName: 'iOS',
      showIosLog: true,
      deviceName: 'iPhone 6',
      nativeInstrumentsLib: true,
      isolateSimDevice: true,
      app: APP_PATH
    }
  }
}
```

For `args`, you can specify keys in lowerCamel.  Its values are interpreted as its value.  If value is boolean, `true` means specifying the key and `false` means not specifying.

For example, `platformVersion: '9.1'` will be converted to `--platform-version=9.1`, `sessionOverride: true` will be `--session-override`, `showIosLog: false` will specify nothing.