Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Supported Environment

InstallationVersion on WindowsVersion on macOS
Android6.x, 7.x6.x, 7.x
iOSN/A9, 10

Xcode 9 and Appium 1.7 are NOT supported

Setup Prerequisites

Katalon Studio requires latest installation of Appium, Node.js. Please setup as following steps:

  • Install Homebrew from Terminal:

    Code Block
    /usr/bin/ruby -e "$(curl -fsSL"
  • Install Carthage with Homebrew:

    Code Block
    brew install carthage
  • Install node and npm with Homebrew:

    Code Block
    brew install node
    brew install npm
     To make sure Node.js is installed correctly, you can open a new terminal and type which node to see if system can find it.
  • Install Appium with npm

    Code Block
    npm install -g appium @1appium@1.6.5

    Set Appium Directory to "/usr/local/lib/node_modules/appium" in Katalon Preferences (from Katalon menu, go to Preferences > Katalon > Mobile)


You will need to install and configure Xcode in case of testing on iOS devices. Please set up Xcode as following:
  • Open Xcode > Preferences > Accounts: Add developer’s Apple ID

  • Open Terminal at WebDriverAgent in Appium directory folder: <…>/appium/node_modules/appium-xcuitest-driver/WebDriverAgent and enter following command to initialize WebDriverAgent project:

    Code Block
    mkdir -p Resources/WebDriverAgent.bundle
    sh ./Scripts/ -d
  • Open project WebDriverAgent.xcodeproj within folder WebDriverAgent in Xcode.

  • Select target WebDriverAgentLib, in the Signing section, check Automatically manage signing and select the team.

  • Then on the menu bar, select Product > Build

  • Repeat the last two steps for WebDriverAgentRunner

  • Build WebDriverAgent to verify all above steps worked

    Code Block
    xcodebuild -project WebDriverAgent.xcodeproj -scheme WebDriverAgentRunner -destination 'id=<udid>' test
  • In case this dialog is displayed, select Always Allow.
  • You should be able to see Listening on USB as the last line on build output.

Setup Devices


  • Turn on the phone’s developer mode (go to Settings Developer options).
  • Connect your Android Phone to your computer via a USB cable. Just confirm if prompted for accepting/trusting the phone.



  • Connect your iOS Devices to your computer via a USB cable. Just confirm if prompted for accepting/trusting the phone.
  • For iOS 8 and higher, you must enable the service UI automation on the device (connect the iOS device to Xcode) as following steps:
    1. plug in the iOS device 
    2. open Xcode on Mac 
    3. go to Settings on the iOS device > Developer > turn ON UIAutomation
  • For iOS 6 and higher, on your iOS device, go to Settings > Safari > Advanced and enable Web Inspector
  • To test an iOS native application file (.ipa or .app file), make sure the application file is already built and signed properly to deploy on the device. Follow these steps to check if an application file is already built and signed correctly:
    1. Open Xcode and navigate to Window/Devices
    2. Choose your device from the Devices list
    3. Press the “+” button and choose you application file
    4. If installed successfully, the application will appear in the Installed Apps section as shown below 

Test Execution

  • Launch Katalon Studio
  • Open a test project
  • Open a test case or test suite
  • Select the option to execute with iOS device from the Run button of the main toolbar
  • Select your device from the Android Devices list. Click OK



    If you don’t see any device in the list, check to see if the developer option of the phone is turned on (see Setup Devices), then try to reconnect the device again until you are prompted for accepting/trusting the computer, and make sure you accept it.

Table of Contents