Install Reg-suit as a project development dependency, initialize it from your React repository, and point its configuration at screenshots produced by a separate browser-capture step. Reg-suit compares image files; it does not render your React app or create those images for you.
Install Reg-suit in your React repository
From the repository root, install Reg-suit locally so its version and command are recorded with the project tooling:
As an Amazon Associate I earn from qualifying purchases.
npm install -D reg-suit
npx reg-suit initThe initializer is interactive. It can configure Reg-suit and install plugins; choose only integrations your workflow needs. A cloud publisher or notification plugin is not required simply to compare local image files. See the Reg-suit npm documentation and official repository for package and command details.
What’s actually slowing this PC down?
Pick the symptom - the matching free tool is one click away.
Alternative: install the CLI globally
The project README also documents a global installation:
#1 Best Overall
npm install -g reg-suit
cd path-to-your-project
reg-suit init
reg-suit runWith a global install, the command is available outside a project manifest. The local development dependency approach instead keeps the tool alongside repository dependencies and lets project scripts invoke it through npm or npx.
Capture the React states you want to compare
Reg-suit needs image files as input. Add a separate screenshot step that renders the pages, components, or UI states that matter to your project and saves their images to a known directory. The official Puppeteer demo shows browser-based capture; the Reg-suit project also points to React and Storybook-oriented examples. The cited materials do not prescribe one capture framework for every React application.
- Choose representative routes or component states, including important variations such as logged-in, empty, or error states where relevant.
- Use your chosen browser or Storybook capture setup to render each state and save the resulting images.
- Make the capture step repeatable: use consistent viewport dimensions, test data, fonts, and application state so unrelated changes do not create noisy differences.
- Record the image output directory used by that script; Reg-suit must be configured to read the actual output rather than an assumed universal folder.
Configure the image directory and run a comparison
The npm package documentation describes a root-level regconfig.json. Its core section requires actualDir, the directory containing the current captured images. The optional working directory defaults to .reg. Optional comparison thresholds include thresholdRate and thresholdPixel.
Quick wins for a faster PC:
Scan for outdated or missing drivers - takes under a minuteDriver Scan →Repair Windows errors before they cause bigger problemsFix Now →Use the directory your capture command really writes to. For example, if that command saves current images under artifacts/current, the core configuration must point actualDir there; that path is only an example, not a Reg-suit default.
{
"core": {
"actualDir": "artifacts/current"
}
}After initialization and capture, run the comparison from the repository root:
npx reg-suit runFor repeatable local or CI use, make sure the screenshot-generation step runs before Reg-suit and produces the configured directory. Reg-suit can run locally or in CI; its README describes storing snapshots in external cloud storage such as S3 or Google Cloud Storage when a publisher plugin is configured.
Choose optional integrations only when needed
Snapshot persistence
S3 and Google Cloud Storage publisher plugins are available if snapshots need to persist between runs or across CI agents. They are optional extensions, not prerequisites for a local comparison. The cited project sources establish that these plugins exist, but do not establish comparative prices or service quality. See the project README.
The Tool Desk
Outbyte Driver Updater FREEScan for outdated or missing drivers - takes under a minuteDriver Scan →Outbyte PC Repair FREEClear out junk files and repair common Windows errorsFree Scan →Notifications and pull-request reporting
The project lists notifier integrations for GitHub, GitLab, Slack, and Chatwork. For its GitHub notifier, the official plugin guide documents installing reg-notify-github-plugin, running reg-suit prepare -p notify-github, installing the Reg-suit GitHub App for the repository, and obtaining the repository client ID. Treat the app and setup flow as optional collaboration configuration; consult the plugin guide for the applicable current steps.
Best Value
Common setup problems and fixes
- No images to compare: Reg-suit does not capture the React app. Run the browser or Storybook capture step first and confirm it writes image files.
- Configured directory is empty or wrong: Check
actualDiragainst the capture script’s real output path, relative to the project root where you run Reg-suit. - Command not found: For a project-local install, run
npx reg-suitfrom the repository or invoke it in a package script. A global command requires the global installation path to be available in your shell. - Unexpected visual differences: Confirm the same route and UI state, viewport, test data, and rendering conditions were used for both image sets before adjusting thresholds. Threshold settings can affect comparison sensitivity, but should not conceal meaningful changes.
- CI cannot access snapshots or report results: Check whether the workflow needs a publisher or notifier plugin and whether its credentials and integration setup are present. These integrations are separate from local image comparison.
Or skip the browser setup:
If your goal is simply to get a clean screenshot from a URL, ScreenshotNeo offers a screenshot API; it does not replace Reg-suit’s image comparison step. One GET request returns an image or PDF:
Quick Recap
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webpSee the ScreenshotNeo API documentation for request options. It accepts cookie/consent banners and removes known consent platforms, newsletter popups, and chat widgets before capture; those steps can be turned off. Bot checks, blank pages, timeouts, failed loads, and cache hits are not billed, and response headers report the page verdict and billing status. Its MCP server provides screenshot tools for AI agents. The free plan includes 1,000 screenshots per month with no card; paid plans start at $5 for 3,000 screenshots.
Sign up for ScreenshotNeo’s free plan.
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
Recommended Free Tools
