Skip to content

Option types⚓︎

Below you will find accepted values of custom option types you can use when providing values to options through environment variables.

boolean⚓︎

Accepted values
  • true 1 yes y on
  • false 0 no n off

Example

1
npx cypress run --env XRAY_UPLOAD_RESULTS=yes

string[]⚓︎

Accepted values
A JSON parseable list of strings.

Info

Parsing is done by Cypress, so it's difficult to actually describe the parsing rules it applies. The most important rules seem to be:

  • add quotes if your string contains whitespace
  • add quotes if your string contains a comma
  • no whitespace outside quotes

Example

1
npx cypress run --env XRAY_TEST_ENVIRONMENTS=[DEV,"Cool Test Environment",2.3]

object⚓︎

Accepted values
A JSON parseable object.

Info

Parsing is done by Cypress, so it's difficult to actually describe the parsing rules it applies. The most important rules seem to be:

  • add quotes if your string contains whitespace
  • add quotes if your string contains a comma
  • no whitespace outside quotes

Example

1
npx cypress run --env JIRA_TEST_EXECUTION='{"fields":{"summary":"My execution!"}}'