Quickstart

Scan a React project, fix what matters, and gate every pull request, in three steps.

1. Scan your project

Run React Doctor from the project root:

npx react-doctor@latest

It auto-detects your framework and React version, scans the code, and prints a health score with the issues it found. No setup or config required.

2. Fix the issues

Re-scan as you work, starting with the highest-severity findings:

npx react-doctor@latest --verbose --diff

--diff scans only the files you changed, so feedback stays fast. Fix error diagnostics first, then warnings that represent real risk. See How to fix issues.

3. Add it to CI

Install the GitHub Action so every pull request gets reviewed automatically:

npx react-doctor@latest install

This writes .github/workflows/react-doctor.yml. On each pull request, React Doctor posts a summary comment, inline review comments, and a commit status, reporting only the issues your change introduced. See GitHub Actions setup.

Next steps

• Install for coding agents: teach your agent the project's quality bar
• Configuration: tune rules, categories, and surfaces
• CLI reference: every command and flag