Improve this doc

Browserstack Service

A WebdriverIO service that manages local tunnel and job metadata for Browserstack users.

Installation

Simply run:

1
npm install --save-dev wdio-browserstack-service

Configuration

WebdriverIO has Browserstack support out of the box. You should simply set user and key in your wdio.conf.js file. This service plugin provdies supports for Browserstack Tunnel. Set browserstackLocal: true also to activate this feature.

1
2
3
4
5
6
7
8
// wdio.conf.js
export.config = {
// ...
services: ['browserstack'],
user: process.env.BROWSERSTACK_USERNAME,
key: process.env.BROWSERSTACK_ACCESS_KEY,
browserstackLocal: true,
};

Options

user

Your Browserstack username.

Type: String

key

Your Browserstack access key.

Type: String

browserstackLocal

Set this to true to enable routing connections from Browserstack cloud through your computer.

Type: Boolean
Default: false

browserstackOpts

Specified optional will be passed down to BrowserstackLocal. See this list for details.

Type: Object
Default: {}

Known Issues

It’s more of how webdriverio desigend the multi-process model. It is extremely hard if not impossible to reliable transfer localIdentifier to child-processes. We recommend to use it without the identifier at this moment, which will create an account-wide local tunnel.