Skip to main content

Comparing Screenshots in Ruby with Applitools


  1. A free Applitools account and Applitools API KEY

    Tip: Unsure how to find your API key?

    Read Retrieving your API key to find your API key.

  2. Ruby

  3. Git

    Note: Installing git is optional

    Installing git is used to clone the demo project from the Github repository. Instead of installing git, you can simply download the Zip file from the repository. Further, if you are Mac, you already have git.

Running the Example Project

  1. Clone or download the repository and navigate to that folder
git clone
cd tutorial-ruby-screenshots

Note: you can alternatively download the project as a Zip file and extract it

  1. Install the dependencies
gem install bundler && bundle install
  1. Run the example test
APPLITOOLS_API_KEY="[Your API Key]" bundle exec ruby simple_test_script.rb

Adding Applitools Eyes to an Existing Project

Install Applitools Eyes dependencies:

gem install eyes_images

Sample test

Having Trouble?

Don't suffer in silence! Let us help you. Please reach out to us to get your project working.

Taking the next steps with Applitools

Congratulations on completing this quickstart! There's still so much to learn about visual testing with Applitools, but you're off to a great start.

Resources for next steps:

  1. 🤖 Learning how visual testing works
  2. ↔️ Setting match levels for visual checkpoints
  3. 💥 Troubleshooting common issues
  4. 🐞 Reporting bugs
  5. 🗺 Detailed overview of visual testing with Applitools

You can also: