Skip to main content

Comparing Screenshots in Java 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. Java v8 or higher

  3. Maven

Tip: Not sure how to install?

Here are some resources:

Make sure it's in your PATH!

To test that it's working:

  • Make sure to restart the Terminal or Command line prompt to load the new environment variables.
  • Run mvn -v

You should see the version info for Maven.

  1. It's better to set APPLITOOLS_API_KEY as a system variable (in Windows) or in the ~/.zshrc recipe file (in MacOS) so that it will be automatically set when you open a new terminal shell.
  2. The Maven executable is inside /bin folder of the extracted Maven directory. So you must include /bin. It should look something like: /Users/raja/apps/apache-maven-3.5.4/bin

Running the Example Project

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

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

  1. Run the example test
APPLITOOLS_API_KEY="[Your API Key]" mvn clean -Dtest=DemoTest test

Adding Applitools Eyes to an Existing Project

  1. Create a Maven project and add the following properties and dependencies to the pom.xml
<!-- This is the Applitools Images Java SDK -->
  1. Create a class with name and add the following code

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: