Simple REPL (Read-eval-print Loop) for controlling mobile apps through Appium

Usage no npm install needed!

<script type="module">
  import appiumRepl from '';



Simple REPL (Read-eval-print Loop) for controlling mobile apps through Appium


wd, or Web Driver/Selenium 2 Client, already contains a REPL detailed here however it requires some tedious boilerplate in order to get into useful REPL operations. This package aims to allow you to bypass that initial effort and get right into a meaningful REPL context.

Getting Started

npm install appium-repl -g to install this module globally

Before Use

Create a .appium-repl.json where ever you intend to execute appium-repl from. This could be inside a project and then kept under your own version control for other developers to use.

Example .appium-repl.json

  "TestApp1" :
      "deviceName": "iPhone Simulator",
      "app": "./path/from/execution/to/your/",
      "platformVersion": "10.1",
      "newCommandTimeout": 100000,
      "autoLaunch" : "true",
      "device": "iPhone 6s"

See more examples in the sample-appium-repl.json file.

Putting it all together

  1. npm install -g appium-repl
  2. create your configuration .appium-repl.json
  3. run the appium server
  • find appium here
  • ensure that you have the appropriate XCode/Android SDKs installed
  • run it, consult appium's documentation if any issues occur
  1. run appium-repl
  2. choose your configuration option (.appium-repl.json can have any number of defined configurations)
  3. access driver directly from the REPL. refer to wd docs for relevant methods
  4. profit?

Example REPL activity (with a Cordova App)

Comments and newlines added for readability

// See all contexts in the app under test
 > CALL contexts()
 > RESPONSE contexts() ["NATIVE_APP","WEBVIEW_56394.1"]
[ 'NATIVE_APP', 'WEBVIEW_56394.1' ]

// Set the context
 > CALL context("WEBVIEW_56394.1")
 > RESPONSE context("WEBVIEW_56394.1")

// Find an element
 > CALL elementById("dashboard-login-button")
 > RESPONSE elementById("dashboard-login-button") {"ELEMENT":"5000"}
Element {
  value: '5000',
   EventEmitter {
     domain: null,
     _events: { status: [Function], command: [Function] },
     _eventsCount: 2,
     _maxListeners: undefined,
      Url {
        protocol: 'http:',
        slashes: true,
        auth: null,
        host: 'localhost:4723',
        port: '4723',
        hostname: 'localhost',
        hash: null,
        search: '',
        query: {},
        pathname: '/wd/hub',
        path: '/wd/hub',
        href: 'http://localhost:4723/wd/hub' },
     sauceTestPageRoot: '',
     sauceRestRoot: '',
      Url {
        protocol: 'http:',
        slashes: true,
        host: 'localhost:4723',
        port: '4723',
        hostname: 'localhost',
        hash: null,
        search: null,
        query: null,
        pathname: '/wd/hub',
        path: '/wd/hub',
        href: 'http://localhost:4723/wd/hub' },
      { browserName: 'firefox',
        version: '',
        javascriptEnabled: true,
        platform: 'ANY' },
      { timeout: undefined,
        retries: 3,
        retryDelay: 15,
        baseUrl: undefined,
        proxy: undefined },
     sessionID: '5ea660da-0541-407c-91cc-f1fa32cf9421' } }

If you press tab it will show you all possible options that are available. If a driver command returns a array then current would become an array.

Async/Await: Run this package with the newest version of node.js and add the --experimental-repl-await flag to use await in the repl: node --experimental-repl-await .