Integration guide

Integrate AppInspect in three steps.

Add the library by build variant, attach the OkHttp interceptor once, and tune the inspector for your team. AppInspect auto-initializes via AndroidX Startup — no Application class changes needed for basic usage.

View on Maven Central Security model

Installation

Install by build variant, not as a blanket dependency.

The recommended setup gives internal builds the full inspector and production builds only the no-op OkHttp counterpart. AppInspect auto-initializes via AndroidX Startup — add the dependency and the inspector is ready, with AppInspect.install() available when you want host-controlled setup.

Add Maven Central

Resolve AppInspect from a shared repository so every developer and CI runner uses the same artifact.

settings.gradle.kts

dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
    }
}

Add the library

Use the full inspector in debug builds. Use the no-op artifact in release builds when you want shared OkHttp setup without inspection behavior.

build.gradle.kts

dependencies {
    debugImplementation("io.github.suryansh1720001.appinspect:appinspect:<latest-version>")
    releaseImplementation("io.github.suryansh1720001.appinspect:appinspect-no-op:<latest-version>")
}

For custom variants, add the full appinspect artifact per variant — e.g. add("stagingImplementation", ...) or add("internalTestImplementation", ...). Check Maven Central for the latest published version. See Security for why the no-op artifact keeps release builds clean.

Attach OkHttp capture

The same builder code compiles across variants. In release, the no-op returns the builder unchanged.

OkHttpClient

val client = OkHttpClient.Builder()
    .addAppInspectInterceptor()
    .build()

Guard direct AppInspect.open() or AppInspect.install() calls by build variant, because the no-op artifact only mirrors the OkHttp API surface.

Configuration

Customize AppInspect for your team workflow.

The default setup is developer-friendly. When the build is shared with a wider QA or business audience, you can hide raw values, disable editing tools, turn off request notifications, or remove panels that are not needed.

Controlled QA profile

AppInspectConfiguration

AppInspect.install(
    application = application,
    configuration = AppInspectConfiguration(
        enablement = AppInspectEnablement(
            allowedBuildTiers = linkedSetOf(AppInspectBuildTier.DEBUG),
        ),
        entryPoints = AppInspectEntryPoints(
            shakeToOpenEnabled = true,
            networkNotificationsEnabled = false,
        ),
        panels = AppInspectPanels(
            crashesEnabled = true,
        ),
        powerTools = AppInspectPowerTools(
            showRawSensitiveValues = false,
            allowSharedPreferencesEditing = false,
            allowDatabaseEditing = false,
            allowSqlConsole = false,
        ),
    ),
)

Configuration levers

enablement.allowedBuildTiers: Decide which build tiers can run the inspector at all. Production stays off unless the host explicitly opts in twice.
showRawSensitiveValues: When false, configured headers, query parameters, body fields, cookies, and metadata keys are masked or removed before storage.
allowDatabaseEditing, allowSqlConsole, allowSharedPreferencesEditing: Keep storage inspection read-only for QA builds that do not need mutation tools.
panels.crashesEnabled: Hide the Crashes tab for audiences that should not see stack traces.
networkNotificationsEnabled: Disable per-request notifications when lock-screen visibility or shared testers are a concern.
launcherShortcutEnabled: Show or hide the launcher shortcut that opens the inspector directly from the device home screen.
autoOpenOnLongPressTrigger: Enable the long-press trigger on views and Compose modifiers (AppInspect.attachLongPressTrigger / Modifier.appInspectLongPressTrigger) that opens the inspector.
openInSeparateTask: Defaults to true — the inspector opens in its own Recents task, split-screen-capable, next to your app. Set to false to open it stacked in the current task instead.

Ready to add it

Add AppInspect to your Android app from Maven Central.

Copy the two Gradle lines above, wire the OkHttp interceptor, and the inspector is live in your next debug build.

Open Maven Central Security model