Skip to content

Update Node.js instructions for version managers #6089

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 1 commit into from
Jan 27, 2025
Merged

Update Node.js instructions for version managers #6089

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 10 additions & 17 deletions docs/app/get-started/install-cypress.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,6 @@ for the download of the Cypress binary. You can also use the npm properties
they will only be used if the system properties are being resolved to not use a
proxy.

:::info

<strong>snap</strong>

The [Node.js Snap for Linux](https://github.com/nodejs/snap) package manager has constrained operating system access. Install using:

```shell
npm install cypress --save-dev --foreground-scripts
```

:::

### <Icon name="download" /> Direct download

The recommended approach is to install Cypress with `npm` because:
Expand Down Expand Up @@ -131,18 +119,23 @@ Cypress generally aligns with

Follow the instructions on [Download Node.js](https://nodejs.org/en/download/) to download and install [Node.js](https://nodejs.org/).

If you are using a [Cypress Docker image](../continuous-integration/overview#Cypress-Docker-variants), you will find a fixed version of Node.js is pre-installed in the image.
You select the Node.js version using the Docker image tag.

:::tip

<strong>Best Practice</strong>

Use a [Node.js package manager](https://nodejs.org/en/download/package-manager/all) to install Node.js.
Package managers for Node.js allow you to switch between different versions easily.
Use a Node.js version manager as suggested on [Download Node.js](https://nodejs.org/en/download/) to install Node.js,
or use an alternate Node.js version manager of your choice.
This allows you to switch between different versions of Node.js easily.

Note that the [Node.js Snap for Linux](https://github.com/nodejs/snap) version manager is not recommended for use with Cypress.
Attempting to use it as a non-root user may result in permissions errors.

:::

If you are using a [Cypress Docker image](../continuous-integration/overview#Cypress-Docker-variants),
you will find a fixed version of Node.js is pre-installed in the image.
You select the Node.js version using the Docker image tag.

### Hardware

When running Cypress locally, it should run comfortably on any machine that is
Expand Down
Loading