Environment Setup


Node.js v8.0 or higher.


Xcode v9 or higher is required.

$ brew install usbmuxd
$ brew install ideviceinstaller
$ brew install ios-webkit-debug-proxy

iOS Real Device

$ DEVELOPMENT_TEAM_ID=TEAM_ID npm i macaca-ios -g


export ANDROID_HOME = /usr/local/opt/android-sdk

gradle is needed in order to build UIAutomatorWD and other package.(For Windows Users plz download gradle installer and set PATH environment variable.)

$ brew install gradle
$ yes | $ANDROID_HOME/tools/bin/sdkmanager --licenses


Default Version

Macaca Cli

Global Installation

$ npm i -g macaca-cli

If you saw the picture below, congratulations! Macaca has been installed successfully!

Local Installation

$ npm i macaca-cli --save-dev

# start Macaca
$ ./node_modules/.bin/macaca run --verbose

Driver Installation

# please run below for newer npm
$ npm i macaca-ios -g


Let’s check the version and verify the environment.

# show version
$ macaca -v

# verify environment
$ macaca doctor

Prepare Application

iOS: An valid iOS application package suffixed with .app.

Android: An valid Android application package suffixed with .apk.

Desktop: All web application could be run with initial url.