Improve this doc

Webdriver.io service plugin for Appium

webdriver.io service plugin for Appium. 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.

1
2
3
4
5
{
"devDependencies": {
"wdio-appium-service": "~0.2.2"
}
}

You can this simply by adding it with:

1
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. 'appium' is used for command. If command key is provided in the configuration, it will be used.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
... // 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.