Skip to content

Commit 576c948

Browse files
committed
Fix verbs and include the config option details. Will figure a better way later.
1 parent 2f6f73e commit 576c948

File tree

1 file changed

+53
-10
lines changed

1 file changed

+53
-10
lines changed

README.md

Lines changed: 53 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ allows you to run your Cypress tests on BrowserStack.
1212
- [Configure Test Runs](#configure-test-runs)
1313
- [Configure Connection Settings](#configure-connection-settings)
1414
- [Disable Usage Reporting](#disable-usage-reporting)
15-
- [CLI Arguments & Flags](#cli-arguments-flags)
16-
- [Running the Tests](#running-the-tests)
17-
- [Getting the Build Information](#getting-the-build-information)
18-
- [Stopping a Running Build](#stopping-a-running-build)
15+
- [CLI Arguments & Flags](#cli-arguments--flags)
16+
- [Run the Tests](#run-the-tests)
17+
- [Get the Build Information](#get-the-build-information)
18+
- [Stop a Running Build](#stop-a-running-build)
1919
- [Limitations](#limitations)
2020
- [License](#license)
2121

@@ -60,6 +60,10 @@ The `init` command will create a sample `browserstack.json` file. This file can
6060
be used to configure your test runs on BrowserStack. Below is the sample file
6161
that is generated for your reference.
6262

63+
You can also specify `--path <path-to-folder-where-you-need-init-to-run>` flag
64+
along with the `init` command to generate `browserstack.json` file in the
65+
specified folder.
66+
6367
```json
6468
{
6569
"auth": {
@@ -217,14 +221,26 @@ Example:
217221

218222
## CLI Arguments & Flags
219223

220-
### Running the Tests
224+
### Run the Tests
221225

222226
You can start running your test build using the following command.
223227

224228
```bash
225229
$ browserstack-cypress run
226230
```
227231

232+
By default, the CLI uses the `browserstack.json` in the directory where the
233+
`run` command is issued. If you need to use a different config file, or are
234+
running from a different directory, you can use the `--cf` or the `--config-file`
235+
option while using `run`. For example,
236+
237+
```bash
238+
$ browserstack-cypress --cf <path-to-browserstack.json> run
239+
240+
# Or
241+
$ browserstack-cypress --config-file <path-to-browserstack.json> run
242+
```
243+
228244
Sample output :
229245

230246
```bash
@@ -242,14 +258,27 @@ Sample output :
242258
[2/20/2020, 2:58:36 PM] File deleted successfully.
243259
```
244260

245-
### Getting the Build Information
261+
### Get the Build Information
246262

247-
In case you want to get information on the build you can use the following command
263+
In case you want to get information on the build you can use the following
264+
command
248265

249266
```bash
250267
browserstack-cypress build-info <buildId>
251268
```
252269

270+
By default, the CLI uses the `browserstack.json` in the directory where the
271+
`build-info` command is issued. If you need to use a different config file, or
272+
are running the command from a different directory, you can use the `--cf` or
273+
the `--config-file` option while using `build-info`. For example,
274+
275+
```bash
276+
$ browserstack-cypress --cf <path-to-browserstack.json> build-info <buildId>
277+
278+
# Or
279+
$ browserstack-cypress --config-file <path-to-browserstack.json> build-info <buildId>
280+
```
281+
253282
Example
254283

255284
```bash
@@ -318,16 +347,29 @@ Sample output:
318347
}
319348
```
320349

321-
**Note:** Each browser version represents a session. It is advised to validate your account's parallel limit before running multiple versions.
350+
**Note:** Each browser version represents a session. It is advised to validate
351+
your account's parallel limit before running multiple versions.
322352

323-
### Stopping a Running Build
353+
### Stop a Running Build
324354

325355
In case you want to stop a running build, you can use the following command
326356

327357
```bash
328358
browserstack-cypress build-stop <buildId>
329359
```
330360

361+
By default, the CLI uses the `browserstack.json` in the directory where the
362+
`build-stop` command is issued. If you need to use a different config file, or
363+
are running the command from a different directory, you can use the `--cf` or
364+
the `--config-file` option while using `build-stop`. For example,
365+
366+
```bash
367+
$ browserstack-cypress --cf <path-to-browserstack.json> build-stop <buildId>
368+
369+
# Or
370+
$ browserstack-cypress --config-file <path-to-browserstack.json> build-stop <buildId>
371+
```
372+
331373
Example
332374

333375
```bash
@@ -355,4 +397,5 @@ Sample output:
355397

356398
## License
357399

358-
This project is released under MIT License. Please refer the [LICENSE.md](LICENSE.md) for more details.
400+
This project is released under MIT License. Please refer the
401+
[LICENSE.md](LICENSE.md) for more details.

0 commit comments

Comments
 (0)