Skip to main content

UI Design Workbench

Русская версия · Changelog · Release guide

Turn repository UI source into an offline interactive HTML workbench—without building or running the application.

UI source → cached UI map → strict UI IR → interactive HTML

Use it to understand unfamiliar UI, inspect screens and navigation, verify a reconstruction, or run an explicit UI/UX review.

Install

Requires Python 3.10+ and pipx.

pipx install ui-design-workbench-cli
uidw install-skill codex

install-skill also supports claude, cursor, gemini, copilot, opencode, agents, and all.

Optional local MCP support:

pipx inject ui-design-workbench-cli "mcp>=2,<3"

Verify the installation:

uidw --version
uidw doctor

Quick start

Choose preview detail once:

uidw --repo <repo> config setup

Build and open the source-derived workbench:

uidw --repo <repo> workbench --output-dir <artifacts> --level full --open

Run a UI/UX audit only when product critique is wanted:

uidw --repo <repo> review --output-dir <review-dir> --level full

workbench and check validate the projection. Only review creates UI/UX findings.

What it provides

  • Screen, route, component, token, theme, and state inventory.
  • Standalone HTML with source links and reconstructed navigation.
  • Incremental scans that reprocess only changed UI files.
  • Property-level evidence and explicit unsupported gaps instead of guessed UI.
  • Sparse review patches and a separate, authorized source-apply step.
  • Structural Android and Apple resource projection, plus discovery of available native capture paths.

Supported source families include Web, React, Vue, Svelte, Jetpack Compose, Android Views XML, SwiftUI, Storyboard/XIB, WinUI/WPF, and Flutter.

Main commands

Command Purpose
uidw doctor Check installation and optional dependencies
uidw --repo <repo> context --json Read compact cached project context
uidw --repo <repo> scope ... Prepare bounded context for a screen or finding
uidw --repo <repo> patch ... Validate or apply sparse review-artifact changes
uidw --repo <repo> workbench ... Build and validate the HTML projection
uidw --repo <repo> native status Discover native Android/Apple render providers without running them
uidw --repo <repo> check ... Repeat projection checks without a UI/UX audit
uidw --repo <repo> review ... Start an explicit UI/UX review
uidw --repo <repo> fidelity ... Inspect source evidence and adapter limits
uidw --repo <repo> mcp Start the optional local stdio MCP server

Run uidw help overview, uidw help advanced, or uidw <command> --help for details.

Accuracy and safety

  • HTML is a static source projection, not proof of runtime or pixel parity.
  • Android and Apple translation remains structural until a source-matched native capture exists.
  • Unsupported bindings, custom drawing, runtime data, and platform behavior remain explicit gaps.
  • Preview and review keep application source read-only; applying a proposal is a separate step.
  • Derived cache and review state live outside the target repository by default.

Upgrade

pipx upgrade ui-design-workbench-cli
uidw install-skill codex

A Windows .exe is not published yet. PyPI + pipx is the primary cross-platform installation path.

Documentation

Current CLI version: 0.5.0.

Metadata

Release files for ui-design-workbench-cli 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ui-design-workbench-cli 0.5.0
File Size Uploaded
ui_design_workbench_cli-0.5.0.tar.gz 278.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ui-design-workbench-cli 0.5.0
File Interpreter ABI Platform
ui_design_workbench_cli-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 798.2 kB

Release files / ui_design_workbench_cli-0.5.0.tar.gz

Download URL ui_design_workbench_cli-0.5.0.tar.gz
Size 278.5 kB
Tags Source
SHA-256 checksum
How to use checksums
0bda599574c1dfbb6640b7db8dbb14138af8f1029c548ddfe0720967c8f45e45
BLAKE2b-256 checksum
How to use checksums
9424ebec2230b66153e3040b44ff69931ec48006e159b39b5862b5ab4f6aaeba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 29, 2026.

Transparency log

Release files / ui_design_workbench_cli-0.5.0-py3-none-any.whl

Download URL ui_design_workbench_cli-0.5.0-py3-none-any.whl
Size 519.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b21f4b6222c779066631ec19c8dfcb99b85ddf342e596367bee12b7b7e938245
BLAKE2b-256 checksum
How to use checksums
861e385c5ef3e65f592927e82bca6b629b49288b4a31f12b8566f7aa023636ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 29, 2026.

Transparency log

Release history Release notifications | RSS feed

0.6.10

2 release files

0.6.9

2 release files

0.6.7

2 release files

0.6.6

2 release files

0.6.3

2 release files

This release

0.5.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page