Reveal Integration Guide

NOTE: The most up to date version of these instructions are always shipped with Reveal. See Help / Integration Guide.

Reveal Integration Guide

To inspect your iOS or tvOS application or app extension with Reveal you must first link it with the Reveal Server framework.

We support a variety of integration approaches:

Minimum Requirements

Reveal requires macOS 10.11+, iOS 8+ or tvOS 9+ and Xcode 7+.

Updating from Reveal 1.x

The names and paths of the bundled frameworks changed in Reveal 2.

If you're using CocoaPods, please ensure your Podfile looks similar to our recommendations, and then run pod install.

If you're using one of the other integration methods, updating from Reveal 1.6.x to Reveal 2.x should be a simple process of removing any references to libReveal.dylib or Reveal.framework from your projects, and then following the instructions for linking the framework or dynamically loading the framework that are linked above.

Further Information

We provide further information on a number of topics in our online Knowledge Base.

Important Information

  • Never ship an app linked against the Reveal library. Reveal exposes your app to deep introspection and will likely cause your app to be rejected by the Apple review team. Reveal is intended for internal development and debugging purposes only.
  • The Reveal service will stop automatically while the iOS or tvOS host app is not the frontmost app. It will automatically start again when the app is re-opened.
  • Reveal supports inspection of applications compiled against iOS 8.0 and later and tvOS 9.0 or later. The iOS Deployment Target build setting must also be 'iOS 8.0' or later in iOS projects. You may see link errors if this is not the case.
  • Reveal can use Bonjour to connect with the running iOS or tvOS application. If you are running the iOS or tvOS application on a device and wish to connect using Bonjour, it will need to be on the same network as the Reveal Mac app to be able to connect with it. If you have any problems connecting to your application check your firewall and proxy settings to ensure they are not blocking communications or just connect your device to your Mac using its lightning cable.