Integrating Reveal with your iOS application

The most up to date version of these instructions are always shipped with Reveal.

See "Help / Integration Guide" in app for the integration guide that's intended for your current version.

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:

Using CocoaPods is the simplest method to integrate Reveal Server into your targets running on device and in the Simulators. It also works for all members of your team.
Loading the Reveal Server via an Xcode Breakpoint allows you to quickly integrate Reveal Server into your Simulator builds without changing anything in your project.
Linking the Reveal Server framework into your application has the same outcome as our CocoaPods integration, but doesn't depend on CocoaPods.
If you're building iOS App Extensions, we provide additional instructions as there are a couple of minor differences in the integration process for App Extensions.

Minimum Requirements

Reveal requires at minimum macOS 15, iOS 13 or tvOS 13 and Xcode 26.

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 13 and later and tvOS 13 or later. The iOS Deployment Target build setting must also be 'iOS 13.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.