iOS SDK

Swift Package Manager

In Xcode, choose File → Add Package Dependencies… and enter the repository URL:

https://github.com/bugscreenapp/bugscreen-ios

Or add it to your Package.swift:

dependencies: [
    .package(url: "https://github.com/bugscreenapp/bugscreen-ios", from: "1.6.0")
]

CocoaPods

Add BugScreenSDK to your Podfile:

pod 'BugScreenSDK', '~> 1.6'

Then run pod install.

Requires iOS 15.0+ and Swift 5.9+.

BugScreen is for dev/QA, so keep it out of what your end users get. Pick the approach that fits your setup:

No-op pod — keep BugScreen out of release builds (CocoaPods)

The cleanest option if you use CocoaPods: ship the real SDK on Debug and the BugScreenSDK-NoOp stub on Release. The stub vends the same BugScreenSDK module with empty implementations, so your call sites compile unchanged — and no BugScreen code, resource bundle, or PrivacyInfo.xcprivacy declarations ship in your production binary.

pod 'BugScreenSDK',      '~> 1.6', :configurations => ['Debug']
pod 'BugScreenSDK-NoOp', '~> 1.6', :configurations => ['Release']

Then call BugScreenSDK.configure(...) with no guard — release builds resolve the no-op and do nothing.

Exclude BugScreen from release builds (SPM)

SPM can't swap dependencies per configuration, but you can still keep BugScreen out of release builds entirely. On your app target's build settings, add the BugScreenSDK* pattern to Excluded Source File Names for every non-Debug configuration, and keep your calls behind the #if DEBUG guard below. The pattern matches the BugScreenSDK package, dropping the whole product from your app's link and resource-copy steps — so release builds link no BugScreen code and ship no resource bundle or PrivacyInfo.xcprivacy.

EXCLUDED_SOURCE_FILE_NAMES = BugScreenSDK*

#if DEBUG guard

Compiles out your call sites. On SPM this alone does not remove the SDK — its code, resource bundle, and PrivacyInfo.xcprivacy still ship in release unless you also apply the exclusion above (or, on CocoaPods, the no-op pod).

import SwiftUI

#if DEBUG
import BugScreenSDK
#endif

@main
struct MyApp: App {
    init() {
#if DEBUG
        BugScreenSDK.configure(
            apiKey: "fb_your_api_key_here",
            enableScreenshotDetection: true
        )
#endif
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

import UIKit

#if DEBUG
import BugScreenSDK
#endif

@main
class AppDelegate: UIResponder, UIApplicationDelegate {
    func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {
#if DEBUG
        BugScreenSDK.configure(
            apiKey: "fb_your_api_key_here",
            enableScreenshotDetection: true
        )
#endif
        return true
    }
}

Tester-flag guard

Runs on production builds for users you flag as testers — useful for dogfooding.

import SwiftUI
import BugScreenSDK

@main
struct MyApp: App {
    init() {
        // currentUser.isTester is pseudocode — replace with your tester signal.
        if currentUser.isTester {
            BugScreenSDK.configure(
                apiKey: "fb_your_api_key_here",
                enableScreenshotDetection: true
            )
        }
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

<key>NSPhotoLibraryUsageDescription</key>
<string>Attach screenshots to bug reports to help us fix issues faster</string>