Skip to content

Commit de0b7a3

Browse files
committed
Update readme for custom commands
1 parent 3d749b7 commit de0b7a3

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ This will create a sample browserstack.json file. This file can be used to confi
5353
}
5454
],
5555
"run_settings": {
56-
"specs": ["folder_path_with_files/*.js"],
56+
"cypress": "/path/to/cypress.json",
5757
"project": "test",
5858
"customBuildName": "cypress build"
5959
},
@@ -73,7 +73,7 @@ The following table provides a reference for all the options that can be provide
7373
| os (case-sensitive) | The operating system in which you want to run your test. | The following three strings are supported."OS X Mojave" , "OS X Catalina", "Windows 10" |
7474
| browser (case-sensitive) | The browser in which you want to run your tests on. | Right now only "chrome", "firefox", and "edge" are supported. We are actively working on supporting other browsers. |
7575
| versions | A list of browser versions that you need to run your tests on | Example: To run on versions 69, 67 and 65 provide ["69", "67", "65"]. Right now edge 80 and all chrome versions from 66 to 78 are supported |
76-
| specs | The path to the spec files that need to be run on BrowserStack | Takes a list of strings that point to location of the spec files |
76+
| cypress | The path to the cypress.json files that need to be run on BrowserStack. This will be considered as root of your project. | |
7777
| project | Name of the project | A string providing the name of the project |
7878
| customBuildName | Helps in providing a custom name for the build | A string providing the name of the build |
7979
| local(boolean: true/false) | Helps in testing websites that cannot be accessed in public network | Set this to true if you need to test a local website. Set this to false if the website is accessible publically. |
@@ -97,7 +97,9 @@ Output :
9797
[2/20/2020, 2:58:34 PM] Test suite: bs://15f90b540b8cbc47929782f35bb7db20fe1c4709
9898
[2/20/2020, 2:58:34 PM] Local is set to: false
9999
[2/20/2020, 2:58:34 PM] Build name is: cypress build
100+
[2/20/2020, 2:58:34 PM] Success
100101
[2/20/2020, 2:58:36 PM] Build created with build id: 06f28ce423d10314b32e98bb6f68e10b0d02a49a
102+
[2/20/2020, 2:58:34 PM] File deleted successfully.
101103
```
102104

103105
### Getting build information
@@ -180,9 +182,8 @@ Output:
180182
### Limitations
181183

182184
- `exec` and `task` are not allowed.
183-
- `baseUrl` is not supported at the moment.
184-
- Environment variables and configuration files are not supported yet.
185185
- While using local, please make sure to create /etc/hosts entry pointing to a URL. The `localhost` is not working at the moment.
186+
- Installing custom npm packages are not supported at this moment.
186187

187188
# Accessing test results
188189

0 commit comments

Comments
 (0)