Installation

Get Oorty set up in your project with a single command.

Requirements

Node.js 18 or higher
A React-based project (Next.js, Vite, Remix, etc.)
npm, yarn, pnpm, or bun

Quick Installation

The fastest way to get started is to run the init command with npx:

Terminal

npx oorty@latest init

This will detect your framework, install dependencies, and scaffold your testing infrastructure.

Using Package Managers

You can also install Oorty globally or as a dev dependency:

Terminal

# Global installation
npm install -g oorty
# Or as a dev dependency
npm install -D oorty
# Then run
npx oorty init

Init Options

The init command accepts several options to customize your setup:

Terminal

npx oorty@latest init [options]
Options:
  -y, --yes          Skip prompts and use defaults
  --typescript       Use TypeScript for test files (default: true)
  --src-dir          Project uses src directory structure
  --skip-install     Skip installing dependencies
  --cwd <path>       Set the working directory
  -h, --help         Display help for command

Existing Projects

If you already have Vitest or Playwright configured, Oorty will detect your existing setup and skip overwriting those files. You can always reinitialize by answering yes when prompted.

What Gets Installed

After running init, Oorty installs the following dependencies:

Unit & Component Testing

vitest
@vitest/coverage-v8
@testing-library/react
@testing-library/jest-dom
jsdom

E2E Testing

@playwright/test

Verify Installation

After installation, run the doctor command to verify everything is set up correctly:

Terminal

npx oorty doctor

You should see all checks passing. If any checks fail, the doctor command will tell you what's wrong and how to fix it.

Next: Quick Start

Learn how to write and run your first tests.

Quick Start