You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+87-2Lines changed: 87 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ export.config = {
40
40
In order to authorize to the BrowserStack service your config needs to contain a [`user`](https://webdriver.io/docs/options#user) and [`key`](https://webdriver.io/docs/options#key) option.
41
41
42
42
### browserstackLocal
43
-
Set this to true to enable routing connections from Browserstack cloud through your computer. You will also need to set `browserstack.local` to true in browser capabilities.
43
+
Set this to true to enable routing connections from Browserstack cloud through your computer.
44
44
45
45
Type: `Boolean`<br />
46
46
Default: `false`
@@ -52,11 +52,96 @@ Type: `Boolean`<br />
52
52
Default: `false`
53
53
54
54
### opts
55
-
Specified optional will be passed down to BrowserstackLocal. See [this list](https://www.browserstack.com/local-testing#modifiers) for details.
55
+
Specified optional will be passed down to BrowserstackLocal.
56
56
57
57
Type: `Object`<br />
58
58
Default: `{}`
59
59
60
+
List of available local testing modifiers to be passed as opts:
61
+
#### Local Identifier
62
+
If doing simultaneous multiple local testing connections, set this uniquely for different processes -
63
+
```js
64
+
opts = { 'localIdentifier':'randomstring' }
65
+
```
66
+
#### Verbose Logging
67
+
To enable verbose logging -
68
+
```js
69
+
opts = { 'verbose':'true' }
70
+
```
71
+
Note - Possible values for 'verbose' modifier are '1', '2', '3' and 'true'
72
+
73
+
#### Folder Testing
74
+
To test local folder rather internal server, provide path to folder as value of this option -
75
+
```js
76
+
opts = { 'f':'/my/awesome/folder' }
77
+
```
78
+
79
+
#### Force Start
80
+
To kill other running Browserstack Local instances -
81
+
```js
82
+
opts = { 'force':'true' }
83
+
```
84
+
85
+
#### Only Automate
86
+
To disable local testing for Live and Screenshots, and enable only Automate -
87
+
```js
88
+
opts = { 'onlyAutomate':'true' }
89
+
```
90
+
91
+
#### Force Local
92
+
To route all traffic via local(your) machine -
93
+
```js
94
+
opts = { 'forceLocal':'true' }
95
+
```
96
+
97
+
#### Proxy
98
+
To use a proxy for local testing -
99
+
100
+
* proxyHost: Hostname/IP of proxy, remaining proxy options are ignored if this option is absent
101
+
* proxyPort: Port for the proxy, defaults to 3128 when -proxyHost is used
102
+
* proxyUser: Username for connecting to proxy (Basic Auth Only)
103
+
* proxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified
By default, BrowserStack local wrappers try downloading and executing the latest version of BrowserStack binary in ~/.browserstack or the present working directory or the tmp folder by order. But you can override these by passing the -binarypath argument.
To save the logs to the file while running with the '-v' argument, you can specify the path of the file. By default the logs are saved in the local.log file in the present woring directory.
140
+
To specify the path to file where the logs will be saved -
0 commit comments