Upload a new build to TestFairy

You can retrieve your API key on your settings page

Supported platforms ios, android
Author @taka0125, @tcurdt, @vijaysharm, @cdm2012

2 Examples

  api_key: "...",
  ipa: "./ipa_file.ipa",
  comment: "Build #{lane_context[SharedValues::BUILD_NUMBER]}",
  api_key: "...",
  apk: "../build/app/outputs/apk/qa/release/app-qa-release.apk",
  comment: "Build #{lane_context[SharedValues::BUILD_NUMBER]}",


Key Description Default
api_key API Key for TestFairy
ipa Path to your IPA file for iOS *
apk Path to your APK file for Android *
symbols_file Symbols mapping file *
upload_url API URL for TestFairy https://upload.testfairy.com
testers_groups Array of tester groups to be notified []
metrics Array of metrics to record (cpu,memory,network,phone_signal,gps,battery,mic,wifi) []
comment Additional release notes for this upload. This text will be added to email notifications No comment provided
auto_update Allows an easy upgrade of all users to the current version. To enable set to 'on' off
notify Send email to testers off
options Array of options (shake,video_only_wifi,anonymous) []
custom Array of custom options. Contact support@testfairy.com for more information ''
timeout Request timeout in seconds

* = default value is dependent on the user's system

Lane Variables

Actions can communicate with each other using a shared hash lane_context, that can be accessed in other actions, plugins or your lanes: lane_context[SharedValues:XYZ]. The testfairy action generates the following Lane Variables:

SharedValue Description
SharedValues::TESTFAIRY_BUILD_URL URL for the sessions of the newly uploaded build
SharedValues::TESTFAIRY_DOWNLOAD_URL URL directly to the newly uploaded build
SharedValues::TESTFAIRY_LANDING_PAGE URL of the build's landing page

To get more information check the Lanes documentation.


To show the documentation in your terminal, run

fastlane action testfairy


It is recommended to add the above action into your Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal

fastlane run testfairy

To pass parameters, make use of the : symbol, for example

fastlane run testfairy parameter1:"value1" parameter2:"value2"

It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.

It is recommended to add all fastlane actions you use to your Fastfile.

Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub

Back to actions