Installation

Learn how to install and configure Verdex for your development environment.

System Requirements

• Operating System: Windows, macOS, or Linux
• Node.js: 18.x or later
• Package Manager: npm 7+, yarn 1.22+, or pnpm 7+
• Disk Space: At least 200MB free space

Installation Options

Option 1: Install as a Project Dependency (Recommended)

For most projects, we recommend installing Verdex as a development dependency:

npm install --save-dev verdex

Or with yarn:

yarn add --dev verdex

Option 2: Global Installation

For quick testing or if you manage multiple projects:

npm install -g verdex

Project Configuration

Create a configuration file in your project root:

// verdex.config.js
module.exports = {
  // Required settings
  testFramework: 'cypress', // or 'playwright', 'selenium', 'puppeteer'
  pageObjectsDir: './src/pages',
  outputDir: './src/generated',
  
  // Optional settings
  includeComments: true,
  verbose: true,
  typescript: true,
  linting: true,
  
  // Advanced settings
  templates: {
    pageObject: './templates/page.template.js',
    component: './templates/component.template.js'
  },
  ignore: ['**/node_modules/**', '**/dist/**']
};

Verification

Verify the installation by running:

npx verdex --version