Cypress Installation
Cypress installs like any other JavaScript package. You need Node.js on your computer before you install Cypress. This topic walks through the installation process step by step using simple language.
Checking Node.js
Node.js is a program that runs JavaScript outside a browser. Cypress depends on Node.js to install and run its files. Open a terminal and type a version check command to confirm Node.js exists on your machine.
node -vA version number confirms Node.js is ready. A missing command means you need to install Node.js first from its official website.
A Simple Way to Picture It
Think of Node.js as the engine of a car and Cypress as the car body. The body cannot move without the engine underneath it. Installing Node.js first prepares the engine for Cypress to sit on top of it.
Creating a Project Folder
Cypress lives inside a project folder alongside your test files. Create a new folder and move into it using terminal commands.
mkdir my-cypress-project
cd my-cypress-project
npm init -yThe last command creates a configuration file that tracks your project's packages.
Installing Cypress
Run the following command inside your project folder:
npm install cypress --save-devThis command downloads Cypress and adds it to your project. The download size is larger than typical packages because Cypress bundles its own browser testing engine.
Installation Flow
Install Node.js
|
v
Create project folder
|
v
Run npm init
|
v
Run npm install cypress
|
v
Cypress files appear in your project
Opening Cypress for the First Time
Run this command to launch the Cypress application:
npx cypress openA window appears showing setup options for different testing types. Cypress creates a set of example files inside your project automatically. These examples show working test patterns you can study and modify.
Choosing a Testing Type
Cypress asks you to pick between end-to-end testing and component testing during first launch. Beginners should choose end-to-end testing since it covers full page behavior. Component testing suits developers testing individual code pieces in isolation.
Verifying the Installation
Click on any example test file inside the Cypress window. Cypress opens a browser and runs the test automatically. A green checkmark confirms your installation works correctly. A red mark usually points to a missing dependency or a blocked browser.
Installing a Specific Version
Some projects require an exact Cypress version for compatibility reasons. Add the version number directly to your install command.
npm install cypress@13.6.0 --save-devThis locks your project to a tested and stable version.
Common Installation Issues
Slow internet connections may cause the download to time out. Corporate networks sometimes block the Cypress binary download. Restarting the install command usually resolves temporary network issues.
Key Points
- Node.js must exist on your machine before installing Cypress.
- The npm install command downloads Cypress into your project folder.
- The npx cypress open command launches the Cypress application window.
- Cypress generates example tests automatically after first launch.
- You can lock a project to a specific Cypress version if needed.
