Skip to main content

Vitaq AI Service

wdio-vitaqai-service is a 3rd party package, for more information please see GitHub | npm downloads

Supports WebdriverIO version 8

Vitaq AI is a unique AI-powered cloud based test automation tool built on WebdriverIO. Accessed through your browser to easily capture a graphical digital twin of your application. It extends the full capability of Webdriverio into a model-driven approach for web, mobile and API testing.

  • Uses the power of variability to find defects that other approaches miss.
  • Measures and analyses what has been tested and what has not been tested into a user journey cloud based test coverage database.
  • Reduces your risks with machine learning by prioritising your most critical user journeys.


This is one of a number of packages that are required to integrate WebdriverIO with Mocha and Vitaq, this is the master package and the other required packages are dependencies of this package.

The easiest way is to keep wdio-vitaqai-service as a devDependency in your package.json e.g:

"devDependencies": {
"wdio-vitaqai-service": "^1.1.26"

You can install it either with npm:

npm install wdio-vitaqai-service --save-dev

or Yarn:

yarn add wdio-vitaqai-service --dev

Instructions on how to install WebdriverIO can be found here.


If you want to do an incremental upgrade of this package, then it can be done with npm:

npm install wdio-vitaqai-service@<version> --save-dev

or Yarn:

yarn add wdio-vitaqai-service@<version> --dev

where <version> should be substituted with the version you wish to install.


In order to use this package the WebdriverIO configuration file (default name wdio.conf.js) needs to be modified in the following ways:

  1. Group the specs so they are all run in the same runner instance:
    "specs": [
  1. Set the framework to be vitaqai-mocha:
    "framework": "vitaqai-mocha",
  1. Add the vitaqai service and the parameters:
"services": [
["vitaqai", {
"userName": "",
"testActivityName": "Shopping_Site_Test",
"projectName": "Surf_Shop",
"url": "",
"userAPIKey": "..."


  • userName - refers to the user name of your account on
  • testActivityName - refers to the name of the test activity you wish to use
  • projectName - refers to the project containing the test activity
  • url - is the URL for the Vitaq
  • userAPIKey - is the API key copied from your account

Mocha Options can be added in the usual way

For more information on WebdriverIO see the homepage.


Details of all of the above configuration options and details of command line usage can be found in the Vitaq AI WebdriverIO Service documentation.

Getting Started with VitaqAI for WebdriverIO​

The quickest way to get started with Vitaq is to:

  1. Register for an account on
  2. Follow the steps in the getting started with Vitaq AI guide to run through the example we have provided.
  3. Create your own test activity diagram and follow the steps to get that running.