Skip to main content

Testing native iOS apps using Calabash


  1. Create a free Applitools account and get your Applitools API KEY

  2. Set the APPLITOOLS_API_KEY environment variable



    1. You may skip this step if you want to hard code the API KEY inside the tutorial project's code.
    2. 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.
  3. Install git from​


    Installing git is optional. You need this mainly to clone the demo project from the Github repository. Instead of installing git, you can simply download the Zip file from the repo. Further, If you are using Mac OSX, you already have git.

  4. Build the application using XCode (ensure that -cal target is built)

🚀 Run the existing demo app​

  1. Get the code:

    • Option 1: git clone
    • Option 2: Download it as a Zip file and unzip it.
  2. From the command line:

    • cd path/to/app/home
    • bundle install
    • bundle exec cucumber

🤓 Add Applitools to an existing project​

Install the SDK​

gem install eyes_calabash

Example Calabash iOS Feature​

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:​