Appearance
Documentation / local-testing-binary / BaseLocalBinaryFlags
Interface: BaseLocalBinaryFlags
Defined in: local-testing-binary/src/local-testing-binary-options.ts:39
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
daemon? | boolean | Starts or stop the binary as a daemon. Accepts only 2 commands: start, stop. Start will start binary in background. Primarily used in Continous Integration server scripts. | local-testing-binary/src/local-testing-binary-options.ts:86 |
debug? | object | - | local-testing-binary/src/local-testing-binary-options.ts:143 |
debug.level? | 2 | 1 | 3 | Sets the level of logging required. Set 1 to debug issues related to setting up connections. Set 2 for logs related to network information. Set 3 to dump all communication to local servers for each request and response. Default: 1 verbose | local-testing-binary/src/local-testing-binary-options.ts:152 |
debug.logFile? | string | Logs all the output to the file specified. log-file | local-testing-binary/src/local-testing-binary-options.ts:158 |
forceLocal? | boolean | Route all traffic via machine where BrowserStackLocal Binary is running. Local tries to fetch public URLs directly, unless this option is specified. | local-testing-binary/src/local-testing-binary-options.ts:115 |
hosts? | object | Granular control over URLs accessible through tunnel. | local-testing-binary/src/local-testing-binary-options.ts:120 |
hosts.exclude? | string[] | Granular control over the URLs that you want to disallow from your tunnel. Wildcards are supported. This flag supersedes hosts.include You can also include specific IPs or IP ranges (subnet) Examples [".*.google.com"] ["127.0.0.1" "8.8.8.8"] ["255.255.255.252/30"] exclude-hosts | local-testing-binary/src/local-testing-binary-options.ts:140 |
hosts.include? | string[] | Granular control over the URLs that you want to tightly bind to your tunnel. Wildcards are supported. You can also include specific IPs or IP ranges (subnet) Examples ["myinternalwebsite.*" ".*.browserstack.com"] ["127.0.0.1" "8.8.8.8"] ["255.255.255.252/30"] include-hosts | local-testing-binary/src/local-testing-binary-options.ts:129 |
localIdentifier? | string | Run multiple copies of the BrowserStackLocal binary (for better performance or other reasons) | local-testing-binary/src/local-testing-binary-options.ts:80 |
more? | string[] | Addtionally, you can pass any other flags that are supported by the BrowserStackLocal binary. | local-testing-binary/src/local-testing-binary-options.ts:164 |
only? | OnlyParam[] | Restrict BrowserStackLocal Binary access to few local servers and/or folders. This flag limits the set of domains that your Local tunnel will resolve for your tests. Regex is not supported, multiple entries are supported. This flag is used to restrict the scope of URLs which the Local Binary can connect to, typically for security and compliance purposes. Usage: host1,port1,ssl?,host2,port2,ssl?. Example: localhost,8000,0,abc.example.com,8080,1 NOTE: This flag is rendered useless when paired with --force-local Please use --include-hosts or --exclude-hosts depending on your use-case. | local-testing-binary/src/local-testing-binary-options.ts:70 |
onlyAutomate? | boolean | This option restricts Binary usage to Automate product, and it cannot be used for Live/Screenshot testing. | local-testing-binary/src/local-testing-binary-options.ts:75 |
parallelRuns? | number | Specify the number of parallel runs. | local-testing-binary/src/local-testing-binary-options.ts:109 |
proxy? | (string | ProxyParams<3128>) & { force?: boolean | undefined; } | If you are behind corporate proxy setup, please specify your proxy host using this option. proxy-* flags pac-file: Use a PAC file to configure the proxy if value is a string file path. Note that this path needs to be present on the local machine. | local-testing-binary/src/local-testing-binary-options.ts:47 |
timeout? | number | Number of (X) minutes in order to auto close the local binary connections (with BrowserStack servers) after X minutes of inactivity. NOTE: There should be no traffic flowing through binary during this period of X. This flag will only work with local binary as of now. | local-testing-binary/src/local-testing-binary-options.ts:95 |