@@ -17,6 +17,7 @@ allows you to run your Cypress tests on BrowserStack.
17
17
- [ Run the Tests] ( #run-the-tests )
18
18
- [ Get the Build Information] ( #get-the-build-information )
19
19
- [ Stop a Running Build] ( #stop-a-running-build )
20
+ - [ Disable CLI Usage Reporting] ( #disable-cli-usage-reporting )
20
21
- [ Limitations] ( #limitations )
21
22
- [ License] ( #license )
22
23
@@ -277,7 +278,7 @@ In case you want to get information on the build you can use the following
277
278
command
278
279
279
280
``` bash
280
- browserstack-cypress build-info < buildId>
281
+ $ browserstack-cypress build-info < buildId>
281
282
```
282
283
283
284
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
295
296
Example
296
297
297
298
``` bash
298
- browserstack-cypress build-info 06f28ce423d10314b32e98bb6f68e10b0d02a49a
299
+ $ browserstack-cypress build-info 06f28ce423d10314b32e98bb6f68e10b0d02a49a
299
300
```
300
301
301
302
Sample output:
@@ -368,7 +369,7 @@ your account's parallel limit before running multiple versions.
368
369
In case you want to stop a running build, you can use the following command
369
370
370
371
``` bash
371
- browserstack-cypress build-stop < buildId>
372
+ $ browserstack-cypress build-stop < buildId>
372
373
```
373
374
374
375
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
386
387
Example
387
388
388
389
``` bash
389
- browserstack-cypress build-stop 06f28ce423d10314b32e98bb6f68e10b0d02a49a
390
+ $ browserstack-cypress build-stop 06f28ce423d10314b32e98bb6f68e10b0d02a49a
390
391
```
391
392
392
393
Sample output:
@@ -400,6 +401,19 @@ Sample output:
400
401
}
401
402
```
402
403
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
+
403
417
## Limitations
404
418
405
419
- ` exec ` and ` task ` are not allowed.
0 commit comments