https://github.com/zeusssz/vulture
CLI tool for automated visual regression testing, comparing screenshots of web pages to detect differences.
https://github.com/zeusssz/vulture
cli comparison-tool ruby screenshot-comparison
Last synced: 5 months ago
JSON representation
CLI tool for automated visual regression testing, comparing screenshots of web pages to detect differences.
- Host: GitHub
- URL: https://github.com/zeusssz/vulture
- Owner: zeusssz
- License: mit
- Created: 2024-09-11T10:35:20.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T14:17:00.000Z (over 1 year ago)
- Last Synced: 2025-07-12T15:40:10.423Z (12 months ago)
- Topics: cli, comparison-tool, ruby, screenshot-comparison
- Language: Ruby
- Homepage:
- Size: 73.2 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#  *Vulture*
    
**Vulture** is a CLI tool designed to automate visual regression testing by comparing screenshots of web pages. Vulture captures screenshots of two URLs at multiple resolutions and generates a "diff" image highlighting visual differences. It's ideal for developers, testers, and designers who want to ensure consistency across different versions of a website or between different environments.
## Key Features
- **Cross-Platform:** Works seamlessly on Windows, Linux, and macOS.
- **Flexible Comparison:** Compare two URLs side-by-side or monitor changes over time.
- **Customizable Resolutions:** Supports multiple screen resolutions for responsive testing.
- **Integration-Ready:** Easily integrates with CI/CD pipelines for automated visual testing.
- **Comprehensive Reporting:** Generates an HTML report to visually display differences.
## Installation
You can install **Vulture** from [RubyGems](https://rubygems.org/gems/vulture) or GitHub Packages.
### 1. Install from RubyGems
To install the latest version from RubyGems, run:
```sh
gem install vulture
```
>[!NOTE]
> To install a previous version of Vulture, run:
> ```sh
> gem install vulture -v [version-number] (e.g., 1.0.0)
> ```
### 2. Install from GitHub Packages
To install **Vulture** from GitHub Packages, you'll need to authenticate with GitHub and add GitHub Packages as a source. Add the following to your `.gemrc` file:
```yaml
---
:backtrace: false
:bulk_threshold: 1000
:sources:
- https://rubygems.org/
- https://rubygems.pkg.github.com/zeusssz
:update_sources: true
:verbose: true
```
Then, run:
```sh
gem install vulture --source=https://rubygems.pkg.github.com/zeusssz
```
## Usage
Run **Vulture** by providing two URLs for comparison:
```sh
vulture
```
### Example
To compare the homepage and the "About" page of a website:
```sh
vulture https://example.com https://example.com/about
```
## License
**Vulture** is released under the MIT License. See the [LICENSE](LICENSE) file for details.
---
>[!IMPORTANT]
> Vulture is in its infancy, meaning bugs will be present! File issues/suggestions to improve Vulture in the issues tab, and **report vulnerabilities to `roboxer_` on Discord**, and *DO NOT* make an issue for those.