Skip to content

Commit b9794a7

Browse files
committed
Add disable usage reporting CLI flag details. Add $ for CLI commands to be consistent.
1 parent ecf0e81 commit b9794a7

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ allows you to run your Cypress tests on BrowserStack.
1717
- [Run the Tests](#run-the-tests)
1818
- [Get the Build Information](#get-the-build-information)
1919
- [Stop a Running Build](#stop-a-running-build)
20+
- [Disable CLI Usage Reporting](#disable-cli-usage-reporting)
2021
- [Limitations](#limitations)
2122
- [License](#license)
2223

@@ -277,7 +278,7 @@ In case you want to get information on the build you can use the following
277278
command
278279

279280
```bash
280-
browserstack-cypress build-info <buildId>
281+
$ browserstack-cypress build-info <buildId>
281282
```
282283

283284
By default, the CLI uses the `browserstack.json` in the directory where the
@@ -295,7 +296,7 @@ $ browserstack-cypress --config-file <path-to-browserstack.json> build-info <bui
295296
Example
296297

297298
```bash
298-
browserstack-cypress build-info 06f28ce423d10314b32e98bb6f68e10b0d02a49a
299+
$ browserstack-cypress build-info 06f28ce423d10314b32e98bb6f68e10b0d02a49a
299300
```
300301

301302
Sample output:
@@ -368,7 +369,7 @@ your account's parallel limit before running multiple versions.
368369
In case you want to stop a running build, you can use the following command
369370

370371
```bash
371-
browserstack-cypress build-stop <buildId>
372+
$ browserstack-cypress build-stop <buildId>
372373
```
373374

374375
By default, the CLI uses the `browserstack.json` in the directory where the
@@ -386,7 +387,7 @@ $ browserstack-cypress --config-file <path-to-browserstack.json> build-stop <bui
386387
Example
387388

388389
```bash
389-
browserstack-cypress build-stop 06f28ce423d10314b32e98bb6f68e10b0d02a49a
390+
$ browserstack-cypress build-stop 06f28ce423d10314b32e98bb6f68e10b0d02a49a
390391
```
391392

392393
Sample output:
@@ -400,6 +401,19 @@ Sample output:
400401
}
401402
```
402403

404+
### Disable CLI Usage Reporting
405+
406+
The CLI collects anonymized usage data including the command-line arguments
407+
used, system details and errors that you get so that we can improve the way
408+
you run your Cypress tests on BrowserStack. Usage reporting is enabled by
409+
default - you can disable usage reporting by using the
410+
`--disable-usage-reporting` flag. You can also do this by setting the
411+
`disable_usage_reporting` option to `"true"` in `browserstack.json`.
412+
413+
```bash
414+
$ browserstack-cypress --disable-usage-reporting <your-commands>
415+
```
416+
403417
## Limitations
404418

405419
- `exec` and `task` are not allowed.

0 commit comments

Comments
 (0)