Reg-suit compares current image files with previously stored snapshots and produces an HTML report of visual differences. It does not create the screenshots: you must generate those upstream, then configure reg-suit to identify, retrieve, compare, and publish snapshots. That makes it a fit for teams that already produce images in a Node.js build or test pipeline and want a plugin-based comparison workflow.
What reg-suit does—and what it does not
The project describes reg-suit as a command-line interface for visual regression testing. Its input is a directory of images to assert against expected snapshots. On a run, it can retrieve the relevant expected images, compare them with the current files, create a report, and publish the results through configured plugins. The documented workflow can run locally or in CI. The project README describes the CLI and workflow.
As an Amazon Associate I earn from qualifying purchases.
Screenshot creation is a separate step. In the official Puppeteer demonstration, Puppeteer captures an image before reg-suit runs. If your test pipeline does not already generate stable image files, you need to build that capture step as well.
How a reg-suit run works
The README summarizes reg-suit run as a sequence equivalent to synchronizing expected images, comparing, publishing, and optionally notifying. The exact behavior depends on the plugins you install and configure.
#1 Best Overall
- Universal Compatibility: Designed for use with any screen, this all-in-one visual acuity chart does not require a computer. Suitable for all monitors, it's compact and easy to install. Supports HDMI connection for direct plug-and-play use.
- Comprehensive Testing: Includes all tests such as Ishihara, Cross Cylinder, Red Green Balance, Fixation, Astigmatism, Cross Grid, Coincidence, Schober, Worth 4 Dot, Red Green Panel, Traffic Lights and more. Allows continuous testing at varying distances from 1m to 7m with random sequencing of optotypes. Offers the option for Imperial or Metric standards, plus randomize and mirror functions.
- Plug and Play Convenience: Smart calibration ensures compatibility with any monitor or TV set. Enjoy full functionality with multiple charts for seamless testing.
- Compact and Versatile Design: The small-sized remote is perfect for one-handed control, ensuring convenience during testing. Display video, audio, and pictures with customizable storage options. Utilizes a 5G system storage for easy access. Offers optional power supply solutions via USB port or charger.
- RF Wireless Remote Control: Features a fluorescent keypad with RF wireless technology for hassle-free control. With omnidirectional 2.4G RF remote control, no direct aiming is required, ensuring a longer working distance, faster response time, and reliable performance.
- Generate actual images. Your application or test tool writes the current screenshots into the configured
actualDir. - Identify expected snapshots. A key-generator plugin determines which snapshot set corresponds to the run. The repository documents Git-derived commit keys and arbitrary-string keys.
- Retrieve expected images. A publisher plugin fetches the baseline snapshots from its configured storage.
- Compare and report. Reg-suit compares actual and expected images using the configured thresholds and writes an HTML report.
- Publish and notify. The publisher can store actual snapshots and the report; optional notifier plugins can send results to configured services.
You can run the combined workflow with reg-suit run. The README also describes the constituent commands as sync-expected, compare, and publish -n; running phases separately can help isolate setup or comparison problems. See the README for the command and plugin details.
Set up a first project
The documented onboarding uses the CLI, a project configuration, an image directory, and any required storage or notification plugins. The commands below follow the project README’s basic sequence.
- Install the CLI:
npm install -g reg-suit. Alternatively, use the package within your project’s workflow rather than relying on a global installation. - Initialize configuration: from the project directory, run
reg-suit initand answer the prompts to configure reg-suit and select plugins. - Prepare actual images: make your screenshot or rendering step write image files into the directory you will set as
core.actualDir. - Review the generated configuration: the official example uses
regconfig.jsonin the project root. Set the actual-image directory and configure the selected key-generator, publisher, and any notifier. - Run the workflow: execute
reg-suit runand inspect the generated report and published results.
The official README contains the initialization and configuration examples. Treat example threshold values as examples, not universal settings.
Recommended Free Tools
Rank #2
- Quick Detection, Safety First: Guard-101 4 gas monitor multi gas detector is designed for rapid detection of 4 types of gases (H2S, CO, LEL, O2). The battery life lasts up to 14 hours, ensuring long-term monitoring of gas concentrations
- User-Friendly Design: Guard-101 gas detector is made of high-strength ABS engineering plastic, which is waterproof, dustproof, and explosion-proof. Its back clip design makes it easy to carry in the workplace. Password protection prevents accidental operation, with an initial password of "69"
- Triple Alarm, Data Storage: Guard-101 4 gas monitor multi gas detector utilizes three alarm modes: LED light, vibration, and sound. It responds within 0.5 seconds and continues to alarm until the gas concentration returns to normal. The Guard-101 also features an alarm record storage function, allowing you to check monitoring data at any time
- Professional Certification: The Guard-101 4 Gas Monitor has passed rigorous safety tests conducted by internationally authorized institutions. It holds valid certification and meets industry standards, ensuring high reliability and accuracy in various environments
- What You Get: Your purchase includes a Guard-101 gas detector, a packaging box, a user manual, a charging cable, and a standard gas hood. This device is suitable for a wide range of applications, including industrial manufacturing, mining, agriculture, emergency rescue, and home use
Configure image comparison and plugins
Core settings
core.actualDir is required: it points to the current images reg-suit should compare. The documented optional core settings include the working directory (default .reg), changed-pixel rate or absolute pixel thresholds, color matching threshold, antialias handling, x-img-diff reporting options, and comparison concurrency (documented default: 4). These controls determine how sensitive the comparison is; tune them against your application’s normal rendering variation rather than copying a sample value. The README’s example thresholdRate of 0.05 is an example, not a recommended baseline or a measured accuracy target.
Storage and notification plugins
Plugin settings are keyed by plugin name. The README demonstrates substituting an environment variable for a bucket name, a useful pattern for keeping environment-specific configuration out of a hard-coded example. You still need to configure credentials and settings for the external storage service you choose.
The repository lists publisher plugins for Amazon S3 and Google Cloud Storage, plus notifier plugins for GitHub, GitLab, GitHub Enterprise, Slack, and Chatwork. It also lists key generators for Git-derived commit keys and arbitrary strings. These are integrations documented by the project; their listing alone does not establish that each external service or plugin remains supported today. Check the relevant plugin documentation and service requirements before adopting one.
Rank #3
- WANLUTECH analog camera tester supports to test max 8MP AHD/8MP TVI/8MP CVI/Analog CVBS camera. Using HD app can automatically recognize AHD CVI TVI cameras and display resolution and frame rate on the screen, support coaxial PTZ & call OSD menu (PLEASE NOTE that this model doe not support test IP network camera)
- UTP Cable Tester: UTP cable continuity test and display on the screen, support to detect the near-end fault point of the RJ45 cable plug on the tester, support for measuring network cable length (When testing the length of the network cable, one end of the network cable should be connected to the tester and the other end of the cable cannot be connected to other devices), test length max 3000 meters
- CVBS video signal test, 1 channel BNC input, NTSC/PAL (Auto adapt), PTZ control, RS485 control, Baud 600-115200bps, compatible with more than 30 protocols. Support audio test, 1 channel audio signal input, test the audio whether is normal
- Built-in 3.7V/4000mAh battery. LED flashlight provides light for dark work environments. Power output: DC12V/1A. Power input: DC5V/2A. 4.3 inches screen, 480*272 resolution. Package include: 1x cctv tester, 1x 5V 2A USB charging cable, 1x BNC cable, 1x RS485 cable, 1x audio cable
- PLEASE NOTE: there is a paper piece isolating the battery. Before using the tester, open the battery cover and remove the paper sheet. We are the manufacturer. Any questions, please let us know, We'll get back to you within 12 hours
Optional difference visualization
Reg-suit can use x-img-diff-js for additional structural information about differences, such as inserted or moved regions. In the documented client-invocation setup, it uses WebAssembly and Web Workers in the browser, so the project says a modern browser is needed to view that reporting experience. This is an optional reporting aid, not a substitute for deciding whether a detected visual change is intended.
The Tool Desk
Outbyte PC Repair FREEClear out junk files and repair common Windows errorsFree Scan →Outbyte Driver Updater FREEScan for outdated or missing drivers - takes under a minuteDriver Scan →CI setup: avoid detached-HEAD surprises
The Git-hash key generator needs the current branch name to identify a base commit. The README warns that some CI environments check out commits with a detached HEAD; without usable branch context, the key generator may not be able to locate the expected baseline as intended.
Before running reg-suit in CI, make sure the workflow fetches the relevant branch history or explicitly checks out/attaches the branch, following the CI provider’s checkout behavior and the reg-suit README’s examples. If the comparison selects an unexpected baseline or cannot resolve one, inspect the checked-out ref and fetched branch data first. Using an arbitrary-string key generator is another documented approach, but then your pipeline must define and consistently supply the key that maps runs to expected snapshots.
Rank #4
- Support up to HD TVI video surveillance testing: Support 2MP, 3MP, 4MP, 5MP 8MP. When TVI signal input, the tester will display HD TVI camera image.
- Portable multi-functions CCTV tester with 5 inch TFT-LCD Screen(Not touch screen), 800*480 resolution, make your job more easily with this professional CCTV tester.
- The CCTV tester builts in 18650 2600mA battery, after charging 3-4 hours, working time lasts 11 hours, long standby time. Small body, portable and easier to carry.
- This camera tester also features a multi-purpose testing unit that includes built-in PTZ tester/controller, UTP cable test, audio surveillance test, and power output.
- Support VGA/HDMI 1.1 Compliant Digital input, can be used for debugging DVR/NVR recorder, also can be a display.
GitHub review behavior
The GitHub notifier plugin documentation says it can comment on pull requests and set commit status. Its documented default is to fail status when visual differences are detected. Reviewers can mark an intended change approved using “Approve Review Changes.” Plugin configuration controls pull-request commenting and whether commit status is set. Check the GitHub notifier README for configuration details, and decide how approvals should fit your team’s review process.
Where reg-suit’s limits matter
- It needs upstream image generation. The documented input is a directory of image files, so reg-suit does not replace a browser automation or rendering step.
- Thresholds require team judgment. Changed-pixel thresholds and antialias handling influence sensitivity. The official sources do not establish universal settings or quantify false-positive and false-negative rates.
- Rendering consistency is your responsibility. The cited project material does not establish cross-platform rendering guarantees. Differences in the environment that generates images can affect the comparisons, so teams should keep that environment and its inputs suitably controlled.
- Publishing adds external configuration. Snapshot storage relies on publisher plugins and external services; you need to provide the corresponding settings and credentials. The project material does not establish storage prices or total operating cost.
- Performance and comparative accuracy are not quantified. The cited sources do not provide benchmark results or a comparison against competing tools. Configure comparison concurrency for your pipeline, but do not treat the documented default of 4 as a performance guarantee.
For release activity, avoid drawing a current maintenance conclusion from a relative-age listing alone. The npm package page is the place to check package metadata; version and publication information can change and should be verified there when making an adoption decision.
Troubleshooting common setup failures
- No images are compared: verify that the capture step completed before reg-suit starts, that it wrote files to the configured
core.actualDir, and that the configured path is correct for the job’s working directory. - The expected baseline cannot be found: check that the key-generator plugin is configured, the publisher can access its storage, and the key maps to the expected snapshot set. For Git-derived keys, confirm the CI checkout has branch context rather than only a detached
HEAD. - Publishing or retrieval fails: inspect the selected publisher’s plugin settings, environment-variable substitutions, and external-service credentials. The project’s S3 and GCS options require their respective service configuration.
- Too many differences appear: confirm that actual and expected images were produced under comparable conditions, then review the changed-pixel, color, and antialias settings. Adjust thresholds deliberately; a looser threshold can conceal real changes as well as reduce noise.
- The report lacks structural difference details: check whether optional x-img-diff reporting is configured and whether the browser viewing the report meets the documented modern-browser requirement for its WebAssembly and Web Worker client invocation.
- GitHub status or comments do not match expectations: check the notifier configuration for pull-request commenting and commit-status behavior, and verify the documented approval flow for intentional changes in the plugin README.
Or skip the browser setup
If you need a screenshot-generation step rather than a visual-diff workflow, ScreenshotNeo is a screenshot API and MCP server; it complements reg-suit by supplying images, rather than replacing snapshot comparison. A one-request call returns an image or PDF. Save the returned image into the directory your existing process uses, then run reg-suit as usual.
Best Value
- ACCURATE DETECTION: This radon detector is equipped with a high-precision semiconductor sensor and vented housing. It detects radon from 0.09–1000 pCi/L (3.3–37000 Bq/m³) and supports switching between pCi/L and Bq/m³ units for efficient, efficiently and accurately detect radon for you
- AUDIO & VISUAL ALARM: The detector has an alarm function, and when the radon concentration exceeds the preset limit, the flashing light and buzzer will alert you. Ideal for poorly ventilated basements, homes and construction sites. Alarm threshold and alpha particle sound are adjustable as needed
- SHORT & LONG-TERM MONITORING: This radon monitor logs detailed data. The first reading appears after 12 hours and updates every 60 minutes. It records values for multiple time periods and peak values. Data auto-saves every 6 hours. Each log provides an overview of up to 504 days, and you can store up to 10 logs for reliable long-term radon monitoring
- EASY TO USE & PORTABLE: Equipped with a color TFT 2.0 screen and graphical UI, it clearly displays radon levels for easy operation. Its portable design with an adjustable rear stand lets you easily place and view the device anywhere
- LONG BATTERY LIFE: 2000 mAh rechargeable lithium battery, USB Type‑C charging; full charge in 3.5 hours (power‑off). Up to 45‑day runtime in standby mode with adjustable ECO standby time. It enables continuous monitoring even during travel for your peace of mind
Install Python’s requests package first. Replace the target URL with the page you want to capture and set your API key:
import requests
r = requests.get("https://api.screenshotneo.com/v1/shot", params={"access_key": "YOUR_API_KEY", "url": "https://stripe.com"}, timeout=90)
open("shot.webp", "wb").write(r.content)See the ScreenshotNeo API documentation for request options. Cookie banners, popups, and chat widgets are removed before the shot; bot checks, blank pages, and failed loads are never billed. Its MCP server gives AI agents screenshot tools, and the free plan includes 1,000 screenshots a month with no card; paid plans start at $5 for 3,000. Sign up free for ScreenshotNeo.
Frequently Asked Questions
Can reg-suit run locally as well as in CI?
Yes. The project describes it as usable on a local machine or in CI.
Does reg-suit require GitHub?
No. GitHub is one documented notifier option; the project also lists other notifier plugins, and its key generators include arbitrary-string keys.
Quick Recap
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.
