AgentPreview is a Gradle plugin that captures AndroidX Compose @Preview functions into screenshots and JSON metadata an AI agent can inspect while editing UI. It is built for the tight loop where an agent changes Compose code, captures the affected preview, reads the visual output, and iterates without opening Android Studio or driving the full app.

<module>/build/agentPreviewSnapshots/<sanitized-preview-id>/<platform>-<viewport>/
  screenshot.png
  snapshot.json

Preview ids are sanitized for file paths: :app:main:LoginPreview becomes app-main-LoginPreview, and viewport folders include the platform, for example android-phone.

AgentPreview is one part of a broader Android and agent-UI toolbox. These tools overlap around UI feedback, but they work at different layers:

Use them together when the task crosses layers. For example, A2UI can define the protocol for an agent-rendered experience, AgentPreview can inspect the Compose components that implement that experience, and Android CLI can validate the final running app on an emulator or device.

Use the published Gradle Plugin Portal plugin in the target module that owns the previews. Gradle requires a concrete plugin version, so pin the latest version shown on the Plugin Portal or in the badge above.

plugins {
    id("dev.staticvar.agentpreview") version "<current-version>"
}

If your project uses a version catalog:

# gradle/libs.versions.toml
[versions]
agentPreview = "<current-version>"

[plugins]
agentPreview = { id = "dev.staticvar.agentpreview", version.ref = "agentPreview" }

plugins {
    alias(libs.plugins.agentPreview)
}

For local development against this checkout, add it as an included build in the target project's settings.gradle.kts and omit the version where the plugin is applied:

pluginManagement {
    includeBuild("/path/to/AgentPreview")
    repositories {
        google()
        mavenCentral()
        gradlePluginPortal()
    }
}

plugins {
    id("dev.staticvar.agentpreview")
}

Install the AgentPreview workflow skill with the open skills CLI:

npx skills add static-var/AgentPreview --skill agentpreview

For Codex global install:

npx skills add static-var/AgentPreview --skill agentpreview -g -a codex -y

List previews first:

./gradlew :app:listComposePreviews

Capture previews:

./gradlew :app:captureComposePreviews

For a focused capture while iterating, use the full left-hand id from listComposePreviews, dry-run the plan, then render the same target:

./gradlew :app:captureComposePreviews \
  -PagentPreview.previewNameFilter=:app:main:LoginPreview \
  -PagentPreview.viewportFilter=preview \
  -PagentPreview.maxCaptures=1 \
  -PagentPreview.dryRun=true

./gradlew :app:captureComposePreviews \
  -PagentPreview.previewNameFilter=:app:main:LoginPreview \
  -PagentPreview.viewportFilter=preview \
  -PagentPreview.maxCaptures=1

Outputs are written under:

To generate an advisory accessibility report for the same captured previews:

./gradlew :app:captureComposePreviews \
  -PagentPreview.accessibilityCheck=true

The report copies current-run screenshots into build/agentPreviewReports/accessibility-assets/, checks only previews captured by that command, and does not fail the build for accessibility findings.

Real rendered screenshots crop to detected Compose content by default. If layout or semantics bounds are ambiguous, AgentPreview keeps the full viewport and records the fallback in snapshot.json.

MIT. See LICENSE.