{"id":13482800,"url":"https://github.com/reg-viz/reg-cli","last_synced_at":"2026-05-03T02:03:25.052Z","repository":{"id":38486725,"uuid":"75525101","full_name":"reg-viz/reg-cli","owner":"reg-viz","description":"📷  Visual regression test tool.","archived":false,"fork":false,"pushed_at":"2026-04-29T00:00:45.000Z","size":90618,"stargazers_count":405,"open_issues_count":42,"forks_count":32,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-04-29T01:25:58.766Z","etag":null,"topics":["reg-suit","visual-recognition","visual-regression-testing","visual-tests"],"latest_commit_sha":null,"homepage":"https://reg-viz.github.io/reg-cli/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reg-viz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-12-04T08:06:30.000Z","updated_at":"2026-04-28T23:59:58.000Z","dependencies_parsed_at":"2023-09-22T02:38:39.052Z","dependency_job_id":"860dc2c9-fa01-4d0b-8686-bea8f4b70cf8","html_url":"https://github.com/reg-viz/reg-cli","commit_stats":{"total_commits":571,"total_committers":20,"mean_commits":28.55,"dds":"0.49036777583187385","last_synced_commit":"195e97ff965f4c7f1c32d2e2b070f2b04e131a08"},"previous_names":["bokuweb/reg-cli"],"tags_count":59,"template":false,"template_full_name":null,"purl":"pkg:github/reg-viz/reg-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reg-viz%2Freg-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reg-viz%2Freg-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reg-viz%2Freg-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reg-viz%2Freg-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reg-viz","download_url":"https://codeload.github.com/reg-viz/reg-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reg-viz%2Freg-cli/sbom","scorecard":{"id":247159,"data":{"date":"2025-08-11","repo":{"name":"github.com/reg-viz/reg-cli","commit":"0f2e0a75eab9d9eb5984c97cf533833bbd2bd456"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Code-Review","score":2,"reason":"Found 3/11 approved changesets -- score normalized to 2","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":8,"reason":"binaries present in source code","details":["Warn: binary detected: docs/detector.wasm:1","Warn: binary detected: sample/detector.wasm:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/reg-viz/reg-cli/ci.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/reg-viz/reg-cli/ci.yml/main?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":5,"reason":"SAST tool is not run on all commits -- score normalized to 5","details":["Warn: 16 commits out of 29 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":1,"reason":"9 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx","Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-17T07:48:28.810Z","repository_id":38486725,"created_at":"2025-08-17T07:48:28.810Z","updated_at":"2025-08-17T07:48:28.810Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32555839,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T00:31:16.350Z","status":"online","status_checked_at":"2026-05-03T02:00:09.297Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["reg-suit","visual-recognition","visual-regression-testing","visual-tests"],"created_at":"2024-07-31T17:01:05.617Z","updated_at":"2026-05-03T02:03:25.000Z","avatar_url":"https://github.com/reg-viz.png","language":"JavaScript","funding_links":[],"categories":["Tools and frameworks"],"sub_categories":[],"readme":"![reg-cli](./docs/reg-cli.jpg)\n\n![[Build Status](https://travis-ci.org/reg-viz/reg-cli)](https://travis-ci.org/reg-viz/reg-cli.svg?branch=master)\n![[Build Status](https://ci.appveyor.com/project/bokuweb/reg-cli)](https://ci.appveyor.com/api/projects/status/ir907qbc633q9na4?svg=true)\n![[npm package](https://www.npmjs.com/package/reg-cli)](https://img.shields.io/npm/v/reg-cli.svg)\n![[npm package downloads](https://www.npmjs.com/package/reg-cli)](https://img.shields.io/npm/dm/reg-cli.svg)\n\n\u003e Visual regression test tool with html reporter.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Test](#test)\n- [Contribute](#contribute)\n- [License](#license)\n\n## Installation\n\n### Requirements\n\n - Node.js v18+\n\n`reg-cli` support Node.js v18+\n\n``` sh\n$ npm i -D reg-cli\n```\n\n## Usage\n\n### CLI\n\n``` sh\n$ reg-cli /path/to/actual-dir /path/to/expected-dir /path/to/diff-dir -R ./report.html\n```\n\n####  Options\n\n  * `-U`, `--update` Update expected images.(Copy \\`actual images\\` to \\`expected images\\`).\n  * `-R`, `--report` Output html report to specified directory.\n  * `-J`, `--json` Specified json report path. If omitted `./reg.json`\n  * `-I`, `--ignoreChange` If true, error will not be thrown when image change detected.\n  * `-E`, `--extendedErrors` If true, also added/deleted images will throw an error.\n  * `-P`, `--urlPrefix` Add prefix to all image src.\n  * `-M`, `--matchingThreshold` Matching threshold, ranges from 0 to 1. Smaller values make the comparison more sensitive. 0 by default. Specifically, you can set how much of a difference in the YIQ difference metric should be considered a different pixel. If there is a difference between pixels, it will be treated as \"same pixel\" if it is within this threshold.\n  * `-T`, `--thresholdRate` Rate threshold for detecting change. When the difference ratio of the image is larger than the set rate detects the change. Applied after `matchingThreshold`. 0 by default.\n  * `-S`, `--thresholdPixel` Pixel threshold for detecting change. When the difference pixel of the image is larger than the set pixel detects the change. This value takes precedence over `thresholdRate`. Applied after `matchingThreshold`. 0 by default.\n  * `-C`, `--concurrency` How many processes launches in parallel. If omitted 4.\n  * `-A`, `--enableAntialias` Enable antialias. If omitted false.\n  * `-X`, `--additionalDetection`. Enable additional difference detection(highly experimental). Select \"none\" or \"client\" (default: \"none\").\n  * `-F`, `--from` Generate report from json. Please specify json file. If set, only report will be output without comparing images.\n\n### html report\n\nIf `-R` option set, output html report to specified directory.\nhttps://reg-viz.github.io/reg-cli/\n\n![open](./docs/open.png)\n![close](./docs/close.png)\n![viewer](./docs/viewer.png)\n\n### from json\n\nIf `-F` option set, only report will be output without comparing images.\n\n``` sh\nreg-cli.js -F ./sample/reg.json -R ./sample/index.html\"\n```\n\n- json format\n``` json\n{\n    \"failedItems\": [\"sample.png\"],\n    \"newItems\":[],\n    \"deletedItems\":[],\n    \"passedItems\":[],\n    \"expectedItems\":[\"sample.png\"],\n    \"actualItems\":[\"sample.png\"],\n    \"diffItems\":[\"sample.png\"],\n    \"actualDir\":\"./actual\",\n    \"expectedDir\":\"./expected\",\n    \"diffDir\":\"./diff\"\n}\n```\n\n## Test\n\n```sh\n$ npm t\n```\n\n## Contribute\n\nPRs welcome.\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2017 bokuweb\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n![reg-viz](https://raw.githubusercontent.com/reg-viz/artwork/master/repository/footer.png)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freg-viz%2Freg-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freg-viz%2Freg-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freg-viz%2Freg-cli/lists"}