Suggest an edit

Adding TestFairy to your Cartfile

Once you have Carthage installed, you can begin adding frameworks to your project. Note that Carthage only supports dynamic frameworks, which are only available on iOS 8 or later (or any version of OS X).

  1. Add github "testfairy/testfairy-carthage" to your Cartfile.
  2. Run carthage update.
  3. On your application targets’ “General” settings tab, in the “Linked Frameworks and Libraries” section, drag and drop the TestFairy framework from the [Carthage/Build][] folder on disk.

  1. On your application targets’ “Build Phases” settings tab, click the “+” icon and choose “New Run Script Phase”. Create a Run Script in which you specify your shell (ex: bin/sh), add the following contents to the script area below the shell:

    /usr/local/bin/carthage copy-frameworks

    and add the paths to the TestFairySDK frameworks under “Input Files”, e.g.:


Include TestFairy

  • Open your AppDelegate.m file.

  • Add this line to your imports section:
    #import <TestFairySDK/TestFairySDK.h>

  • Locate application:didFinishLaunchingWithOptions: method and add a call using the App Token from your Account Settings page.

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // Override point for customization after application launch.
    [TestFairy begin:<App token from>];
    return YES;

Automatically Uploading Debug Symbols

  1. You can follow the steps given (here)[] for automatic upload of symbol files, however, you can replace the path to the upload script with the following
${SRCROOT}/Carthage/Build/iOS/TestFairySDK.framework/ API_KEY

Remember to replace API_KEY with your Upload API found in your user preferences at

  1. If you get an error saying that you do not have permission to execute this script, you may need to make the script executable, so find the file on disk, and run the following command at the command line

chmod +x