Skip to content

Add quoting advice for PowerShell CLI options #6169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 7, 2025
Merged

Add quoting advice for PowerShell CLI options #6169

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0dc5187
Add quoting advice for PowerShell CLI options
MikeMcC399 May 4, 2025
f6b71ad
Merge branch 'main' into powershell-quoting
MikeMcC399 May 5, 2025
d009c68
Merge branch 'main' into powershell-quoting
MikeMcC399 May 7, 2025
8d0f439
Fix --config typo
MikeMcC399 May 7, 2025
f3ea619
Merge branch 'main' into powershell-quoting
MikeMcC399 May 7, 2025
d8d5eb0
Merge branch 'main' into powershell-quoting
MikeMcC399 May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/app/references/command-line.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ This guide assumes you've already read our
installed Cypress as an `npm` module. After installing you'll be able to execute
all of the commands in this document from your **project root**.

:::info

You can alternatively require and run Cypress as a node module using our
[Module API](/app/references/module-api).

:::

## How to run commands

You can run Cypress from your **project root** using a command which
Expand Down Expand Up @@ -58,8 +65,9 @@ pnpm cypress run --record --spec "cypress/e2e/my-spec.cy.js"

:::info

You can alternatively require and run Cypress as a node module using our
[Module API](/app/references/module-api).
**PowerShell**

When `cypress run` [options](#Options) or `cypress open` [options](#Options-1) are specified with multiple values separated by commas, such as for `--config` or `--env` options, and you are using PowerShell on Windows, you may need to surround the key/value pairs with quotes, for example: `--env "host=api.dev.local,port=4222"`.

:::

Expand Down