Installation

Install React Doctor and start diagnosing your React codebase

No Installation Required

The fastest way to use React Doctor is with npx. This runs the latest version without installing anything:

npx -y react-doctor@latest .

The -y flag skips the confirmation prompt and ensures you always get the latest version.

Optional: Global Installation

If you prefer to install React Doctor globally:

npm install -g react-doctor

Then run it from any project directory:

react-doctor .

Global installation may not always use the latest version. We recommend using npx for the most up-to-date features and fixes.

System Requirements

Node.js

Version 18 or higher required

React

Works with any React version

TypeScript

TypeScript 5.0.4 - 6.x supported

Frameworks

Next.js, Vite, Remix, CRA, React Native, and more

Verify Installation

Check that React Doctor is working correctly:

npx react-doctor@latest --version

Output

0.0.29

For Coding Agents

If you’re using a coding agent (Cursor, Claude Code, OpenCode, Windsurf, etc.), install the React Doctor skill:

curl -fsSL https://react.doctor/install-skill.sh | bash

The skill teaches your coding agent all 47+ React best practice rules so it can help you fix issues automatically.

Supported coding agents:

• Cursor
• Claude Code
• Amp Code
• Codex
• Gemini CLI
• OpenCode
• Windsurf
• Antigravity

Workspace Projects

React Doctor automatically detects monorepo workspaces. When you run it in a monorepo root, it will:

1. Detect all workspace projects
2. Prompt you to select which projects to scan
3. Scan each selected project independently

Terminal

npx -y react-doctor@latest .

react-doctor v0.0.29

Detected workspace with 3 projects:
  1. packages/web
  2. packages/api
  3. packages/shared

? Select projects to scan: (Press <space> to select, <a> to toggle all)

Skip Project Selection

To scan all projects without prompting:

npx -y react-doctor@latest . --yes

Scan Specific Projects

To scan specific projects by name:

npx -y react-doctor@latest . --project web,shared

Next Steps

Quick Start

Run your first scan and understand the output

Configuration

Customize React Doctor for your project