{"id":13393491,"url":"https://github.com/bbc/wraith","last_synced_at":"2025-05-14T13:09:04.127Z","repository":{"id":6536102,"uuid":"7777332","full_name":"bbc/wraith","owner":"bbc","description":"Wraith — A responsive screenshot comparison tool","archived":false,"fork":false,"pushed_at":"2023-01-15T21:10:16.000Z","size":9471,"stargazers_count":4843,"open_issues_count":125,"forks_count":357,"subscribers_count":161,"default_branch":"master","last_synced_at":"2025-05-07T19:06:40.212Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://bbc-news.github.io/wraith/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bbc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-01-23T15:26:31.000Z","updated_at":"2025-05-04T05:31:12.000Z","dependencies_parsed_at":"2023-01-17T00:00:53.150Z","dependency_job_id":null,"html_url":"https://github.com/bbc/wraith","commit_stats":null,"previous_names":["bbc-news/wraith"],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbc%2Fwraith","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbc%2Fwraith/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbc%2Fwraith/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbc%2Fwraith/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bbc","download_url":"https://codeload.github.com/bbc/wraith/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252940934,"owners_count":21828769,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-07-30T17:00:54.157Z","updated_at":"2025-05-14T13:08:59.079Z","avatar_url":"https://github.com/bbc.png","language":"Ruby","readme":"![Wraith logo](https://raw.githubusercontent.com/BBC-News/wraith/master/assets/wraith-logo.png)\n\n[![build status](https://secure.travis-ci.org/BBC-News/wraith.png?branch=master)](http://travis-ci.org/BBC-News/wraith)\n[![rubygems version](https://img.shields.io/gem/v/wraith.svg)](https://rubygems.org/gems/wraith)\n[![codeclimate report](https://codeclimate.com/github/BBC-News/wraith.png)](https://codeclimate.com/github/BBC-News/wraith)\n\nWraith is a screenshot comparison tool, created by developers at BBC News.\n\n[Documentation](http://bbc-news.github.io/wraith/) • [Source](http://github.com/bbc-news/wraith) • [Responsive News Website](http://responsivenews.co.uk)\n\n## What is it?\n\nWraith uses a headless browser to create screenshots of webpages on different environments (or at different moments in time) and then creates a diff of the two images; the affected areas are highlighted in blue.\n\n![Photo of BBC News with a diff](http://bbc-news.github.io/wraith/img/wraith.png)\n\n## Documentation\n\nFor instructions on how to install, set up and use Wraith and all of its features, [visit the Wraith documentation](http://bbc-news.github.io/wraith/index.html).\n\nA brief overview of how Wraith works is provided below.\n\n## Wraith modes\n\nThere are several ways in which Wraith can be used:\n\n1. Comparison of 2 domains (`wraith capture`). There are also some specialist options within this mode:\n    * Spidering 2 domains for changes (`wraith capture` when no `paths` property is provided in the configuration file)\n    * Running several comparisons at once (`wraith multi_capture`)\n2. Comparing the same domain over time (`wraith history`, then `wraith latest`)\n\nWhichever mode you decide to run Wraith in, the process it follows is generally the same:\n\n* takes screenshots of your webpages\n* runs a comparison task across them\n* outputs a diff PNG file comparing the two images, and a data.txt file which contains the percentage of pixels that have changed\n* packages all of this up into a gallery.html, ready for you to view\n* if any screenshot's diff is above the threshold you specified in your configuration file, the task exits with a system error code (useful for CI)\n* the failed screenshot will also be highlighted in the gallery\n\n## Requirements\n\n[ImageMagick](http://www.imagemagick.org/) is required to compare the screenshots and crop images.\n\nWraith also requires at least one of these headless browsers:\n\n* [PhantomJS](http://phantomjs.org)\n* [CasperJS](http://casperjs.org/) (which can be used to target specific selectors)\n* [SlimerJS](http://slimerjs.org)\n* [Chrome](https://askubuntu.com/questions/510056/how-to-install-google-chrome/510063) (Currently using Selenium WebDriver + Chromedriver for Chrome; Can target specific selectors)\n\n## Contributing\n\nPlease read [how to contribute to Wraith](https://github.com/BBC-News/wraith/blob/master/.github/CONTRIBUTING.md).\n\n## License\n\nWraith is available to everyone under the terms of the Apache 2.0 open source license. [Take a look at Wraith's LICENSE file](https://github.com/BBC-News/wraith/blob/master/LICENSE).\n\n## Credits\n\n * [Dave Blooman](https://twitter.com/dblooman)\n * [John Cleveley](https://twitter.com/jcleveley)\n * [Simon Thulbourn](https://twitter.com/sthulb)\n * [Chris Ashton](https://twitter.com/chrisbashton)\n\n## Selenium-Wraith\n\nAnyone interested in integrating selenium capability with Wraith should check out [Selenium-Wraith](https://github.com/mathew-hall/wraith-selenium) (maintained by Mathew Hall), which was forked from BBC's Wraith on 16/04/14 and adds the following capabilities:\n\n1. Selenium integration, both running locally on a desktop or on a selenium grid\n2. Browser to browser screenshot comparison\n3. Page component-based comparison\n","funding_links":[],"categories":["Browser Testing","Ruby"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbc%2Fwraith","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbbc%2Fwraith","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbc%2Fwraith/lists"}