Adding the TestFairy plugin to your Cordova or Phonegap project is simple.
Cordova provides two workflows for development, either through the command line, or a platform-centered workflow. If your current development leverages the platform-centered workflow, please refer to the iOS integration document for adding TestFairy to your project.
In this article we'll walk you through adding TestFairy to a new project through the command-line workflow.

For Ionic and Ionic 2 applications, please check out the Ionic documentation.



First, make sure you have cordova installed on your machine. To do so you can follow the instructions on getting started.

Once installed, we'll start with creating a new project. If you already have an existing project, please skip to the next step.

To add the plugin to your project via npm, simply run the following command from Terminal:

cordova plugin add com.testfairy.cordova-plugin

Alternatively, you can install it directly from GitHub:

cordova plugin add


To upgrade your plugin, please run:

cordova plugin update com.testfairy.cordova-plugin


Initialize TestFairy with your App Token by calling TestFairy.begin. Your APP TOKEN is available at

It's recommended to invoke TestFairy.begin from onDeviceReady. For example, here's onDeviceReady from index.js:

  onDeviceReady: function() {
    TestFairy.begin("APP TOKEN");

Identifying your users

See the SDK Documentation for more information.

Session Attributes

See the SDK Documentation for more information.

Remote Logging

See the SDK Documentation for more information.

Where to go from here?

Congratulations! You've successfully integrated TestFairy into your Cordova project! Visit your dashboard, where you should see your app listed.

  • Have a look at the API documentation for other calls you can make to the TestFairy plugin

  • Follow the project on GitHub for updates, bug reports, or to contribute to the project!