Reveal Integration Guide

To inspect your iOS or tvOS application with Reveal you must first link your application with the Reveal library, which is packaged within the Reveal application.

Reveal offers three options for integrating the library with your iOS or tvOS application:

Static Linking

Linking Reveal's static library into your iOS or tvOS application is the quickest and easiest way to enable Reveal introspection.

Follow the instructions to integrate Reveal using static linking.

Dynamic Loading

Dynamic loading allows third party libraries to be loaded into an iOS application on demand, at runtime. In this scenario the library is not linked in to the executable, but is instead included in the app bundle and can be loaded on demand. This approach allows developers to maintain full control over when the Reveal library is loaded, and when the service is started and stopped within their application.

Follow the instructions to integrate Reveal using dynamic loading.

CocoaPods

CocoaPods is a dependency management system for iOS, tvOS and OS X projects. It automates the configuration of workspaces to manage 3rd party library dependencies in Xcode projects.

Follow the instructions to integrate Reveal using CocoaPods.

Updating from Reveal 1.0

Updating from Reveal 1.0.x to Reveal 1.6.x should be a simple process whether you're using CocoaPods or have setup Reveal integration yourself.

Reveal 1.6.x requires linking with libz in addition to the existing dependencies you would already have included in your project.

  1. If you've copied the static framework or dynamic library into your project, be sure to copy the latest version from within Reveal (see Help → Show Reveal Library in Finder)
  2. In Xcode's Project Navigator, select your project. For each target that you are using with Reveal you will need to:
    • If you have added the libraries required for Reveal to Link Binary with Libraries, add libz.tbd to the list if it is not already there.
    • If you have linked the libraries required for Reveal via the Other Linker Flags (or OTHER_LDFLAGS) build setting, add -lz to the list of flags if it is not already there.
  3. That's it — run your app and test that you can connect with Reveal!

Upgrading with CocoaPods

  1. Ensure that your Podfile looks similar to the following:

    For iOS projects:

     pod 'Reveal-iOS-SDK', :configurations => ['Debug']

    For tvOS projects:

     pod 'Reveal-tvOS-SDK', :configurations => ['Debug']
  2. Run pod update in your project directory.

  3. That's it — run your app and test that you can connect with Reveal!

Removing Reveal from your Xcode Project

Follow the instructions to remove Reveal from your project.

Important Information

Getting Help

If you have any problems or questions about integrating Reveal into your app, head over to our support site.