mcpField
R
roborazzi

roborazzi

github.com/takahiromTesting & quality1.1k128 installsUpdated 1w ago
Repository

About roborazzi

Roborazzi is an Android screenshot-testing skill for JVM-based tests using Robolectric Native Graphics. It covers views, Jetpack Compose, Compose Previews, and Compose Multiplatform, along with recording, comparison, and verification workflows.

Key features

  1. 01Run screenshot tests as JVM unit tests
  2. 02Test Android views and Jetpack Compose
  3. 03Record, compare, and verify screenshots
  4. 04Capture GIFs and videos
  5. 05Generate UI tree dumps

Use cases

  1. 01Test UI screenshots without a device or emulator
  2. 02Verify screenshot changes in a build workflow
  3. 03Generate screenshot tests from Compose Previews

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/takahirom/roborazzi --skill roborazzi

After installing, type/roborazziin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
ai_powered_image_assertion.md
build_setup.md
compose_multiplatform.md
faq.md
gif_and_video.md
github_actions.md
gradle_properties_options.md
how_to_use.md
idea_plugin.md
preview_support.md
top.md
try_it_out.md
ui_tree_dump.md

Details

From the project README

Roborazzi

Roborazzi is a screenshot testing library for Android that runs on the JVM using Robolectric Native Graphics, so screenshot tests run as JVM unit tests without a device or emulator. It works with plain Android views, Jetpack Compose (including Compose Previews), and Compose Multiplatform.

The typical workflow: record baseline images with ./gradlew recordRoborazziDebug, then compare or verify against them with compareRoborazziDebug / verifyRoborazziDebug (task names vary by variant; see the build setup reference).

Reference index

Read the reference that matches the task at hand:

FileRead when
references/top.mdYou need an overview of what Roborazzi is and why to use it over device tests or Paparazzi.
references/try_it_out.mdYou want a minimal quick start or a sample project to try Roborazzi.
references/build_setup.mdSetting up the Gradle plugin and dependencies, or running/understanding the record/compare/verify Gradle tasks and their outputs.
references/how_to_use.mdWriting tests: captureRoboImage for views/Compose/Espresso, RoborazziRule and its options, output paths and file naming, RoborazziOptions (thresholds, image comparators, dump mode).
references/gif_and_video.mdCapturing GIFs and videos of test interactions: captureRoboGif, recordRoboVideo / recordScreenRoboVideo, RoboVideoOptions, GIF vs APNG output.
references/ui_tree_dump.mdUI tree dump: the machine-readable .uitree.json semantics sidecar and annotated Set-of-Mark image for tools & AI agents (roborazzi.dumpUiTree, uiTreeDumpOptions), including the verify-a-UI-fix-by-bounds workflow.
references/github_actions.mdSetting up GitHub Actions CI for Roborazzi: workflows that store baseline screenshots, verify them, and compare snapshot results on pull requests.
references/preview_support.mdGenerating screenshot tests from @Preview composables with ComposablePreviewScanner, including setup and customization of preview tests.
references/compose_multiplatform.mdScreenshot testing Compose Multiplatform targets (iOS, desktop/JVM), including feature support per platform.
references/ai_powered_image_assertion.mdAsserting screenshot content with AI models (OpenAI, Gemini) via roborazzi-ai modules.
references/gradle_properties_options.mdConfiguring roborazzi.* Gradle properties: task behavior, output directory, file-name strategy, comparison report settings.
references/idea_plugin.mdUsing the Roborazzi IntelliJ IDEA / Android Studio plugin to view screenshots in the IDE.
references/faq.mdTroubleshooting: common errors, CI setup questions, Robolectric configuration issues, and other frequently asked questions.

The files under references/ mirror the official Roborazzi documentation at the time this skill was published. The latest version is always available at the documentation site.

Comments

Markdown supported