Skip to content
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.

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

docs: consolidate cli debug commands #5923

Merged
Merged
Changes from all commits
Commits
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
44 changes: 6 additions & 38 deletions docs/guides/guides/command-line.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -981,48 +981,16 @@ cypress cache prune

### Enable Debug Logs

Cypress is built using the [debug](https://github.com/visionmedia/debug) module.
That means you can receive helpful debugging output by running Cypress with this
turned on prior to running `cypress open` or `cypress run`.

**On Mac or Linux:**

```shell
DEBUG=cypress:* cypress open
```

```shell
DEBUG=cypress:* cypress run
```

**On Windows:**

```shell
set DEBUG=cypress:*
```
If you are using macOS, Linux or Windows (Git Bash)
and your package manager is npm, you can run Cypress with debug logs using the following CLI command:

```shell
cypress run
DEBUG=cypress:* npx cypress run
```

Cypress is a rather large and complex project involving a dozen or more
submodules, and the default output can be overwhelming.

**To filter debug output to a specific module**

```shell
DEBUG=cypress:cli cypress run
```

```shell
DEBUG=cypress:launcher cypress run
```

...or even a 3rd level deep submodule

```shell
DEBUG=cypress:server:project cypress run
```
See [Troubleshooting](../references/troubleshooting#Print-DEBUG-logs) for more detailed instructions on options
to generate debug logs, also with Yarn and pnpm package managers,
and with Windows CMD and PowerShell terminal windows.

## History

Expand Down