Add quoting advice for PowerShell CLI options #6169
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Situation
CLI options that include multiple values separated with commas, such as for
--config
,--env
or--reporter-options
may be misinterpreted when executing Cypress CLI in PowerShell on Windows.The following documentation example cypress run --config generally fails to run in PowerShell
7.5.1
on Windows 11 24H2, Cypress14.3.2
with package managers: npm, pnpm and Yarn:The error is:
An exception is
npm@10.8.2
under Node.jsv20.19.1
usingnpx cypress run
where it works correctly.Using PowerShell
7.5.1
on Ubuntu24.04.2
LTS shows no issues with executing the above command in each of the package managers (npm, pnpm and Yarn).Change
Add an info admonition to https://docs.cypress.io/app/references/command-line to advise enclosing the options in quotes: