Installation

Cepress Generator can be installed globally or used directly with npx. We recommend using npx to always get the latest version.

Using npx (Recommended)

The easiest way to use Cepress Generator is with npx, which will always use the latest version:

Quick Start

npm install -g create-cepress-app
npx create-cepress-app my-app

Global Installation

If you prefer to install globally:

Install globally

npm install -g create-cepress-app

Then create projects with:

Create project after global install

create-cepress-app my-project

Requirements

System Requirements

✓ Node.js 16.x or higher
✓ npm 7.x or higher
✓ Git (recommended for version control)

Verify Installation

To verify that everything is working correctly, create a test project:

Test the installation

# Create a test project
npx create-cepress-app test-project

# Navigate to the project
cd test-project

# Install dependencies
npm install

# Start the development server
npm run dev

If the server starts successfully and shows "Server running on http://localhost:3000", you're all set!

Troubleshooting

Command not found

If you get a "command not found" error, make sure npm's global bin directory is in your PATH.

Check npm prefix

npm config get prefix

Permission errors

On macOS/Linux, you might need to configure npm to avoid permission issues:

Fix npm permissions

# Create a directory for global packages
mkdir ~/.npm-global

# Configure npm to use it
npm config set prefix '~/.npm-global'

# Add to your shell profile (.bashrc, .zshrc, etc.)
export PATH=~/.npm-global/bin:$PATH

Node.js version issues

Cepress Generator requires Node.js 16 or higher. Check your version:

Check Node.js version

node --version

Consider using nvm to manage multiple Node.js versions.