Skip to content

Update README.md #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 10, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,24 @@ npm install browserstack-local

## Example

```
```node
var browserstack = require('browserstack-local');

# creates an instance of Local
//creates an instance of Local
var bs_local = new browserstack.Local();

# replace <browserstack-accesskey> with your key. You can also set an environment variable - "BROWSERSTACK_ACCESS_KEY".
// replace <browserstack-accesskey> with your key. You can also set an environment variable - "BROWSERSTACK_ACCESS_KEY".
var bs_local_args = { 'key': '<browserstack-accesskey>' };

# starts the Local instance with the required arguments
// starts the Local instance with the required arguments
bs_local.start(bs_local_args, function() {
console.log("Started BrowserStackLocal");
});

# check if BrowserStack local instance is running
// check if BrowserStack local instance is running
console.log(bs_local.isRunning());

# stop the Local instance
// stop the Local instance
bs_local.stop(function() {
console.log("Stopped BrowserStackLocal");
});
Expand All @@ -42,31 +42,31 @@ Apart from the key, all other BrowserStack Local modifiers are optional. For the

#### Verbose Logging
To enable verbose logging -
```
```node
bs_local_args = { 'key': '<browserstack-accesskey>', 'v': 'true' }
```

#### Folder Testing
To test local folder rather internal server, provide path to folder as value of this option -
```
```node
bs_local_args = { 'key': '<browserstack-accesskey>', 'f': '/my/awesome/folder' }
```

#### Force Start
To kill other running Browserstack Local instances -
```
```node
bs_local_args = { 'key': '<browserstack-accesskey>', 'force': 'true' }
```

#### Only Automate
To disable local testing for Live and Screenshots, and enable only Automate -
```
```node
bs_local_args = { 'key': '<browserstack-accesskey>', 'onlyAutomate': 'true' }
```

#### Force Local
To route all traffic via local(your) machine -
```
```node
bs_local_args = { 'key': '<browserstack-accesskey>', 'forcelocal': 'true' }
```

Expand All @@ -78,13 +78,13 @@ To use a proxy for local testing -
* proxyUser: Username for connecting to proxy (Basic Auth Only)
* proxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified

```
```node
bs_local_args = { 'key': '<browserstack-accesskey>', 'proxyHost': '127.0.0.1', 'proxyPort': '8000', 'proxyUser': 'user', 'proxyPass': 'password' }
```

#### Local Identifier
If doing simultaneous multiple local testing connections, set this uniquely for different processes -
```
```node
bs_local_args = { 'key': '<browserstack-accesskey>', 'localIdentifier': 'randomstring' }
```

Expand All @@ -94,14 +94,14 @@ bs_local_args = { 'key': '<browserstack-accesskey>', 'localIdentifier': 'randoms

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.
Path to specify local Binary path -
```
```node
bs_local_args = { 'key': '<browserstack-accesskey>', 'binarypath': '/browserstack/BrowserStackLocal' }
```

#### Logfile
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.
To specify the path to file where the logs will be saved -
```
```node
bs_local_args = { 'key': '<browserstack-accesskey>', 'v': 'true', 'logfile': '/browserstack/logs.txt' }
```

Expand Down