Skip to main content

UI Design Workbench

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

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.
  • Runtime-free Android, Apple, and Flutter source projection with deterministic geometry for the supported subset; native evidence is required only before claiming visual or pixel parity and is never launched automatically.

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 deterministic runtime-free source projection for the supported shared layout subset, not proof of runtime or pixel parity.
  • Android, Apple, and Flutter translation uses deterministic projection geometry for the supported shared layout subset; without separate native evidence it remains a structural projection, not proof of runtime or pixel parity.
  • 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.6.6.

Metadata

Release files for ui-design-workbench-cli 0.6.6

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.6.6
File Size Uploaded
ui_design_workbench_cli-0.6.6.tar.gz 310.0 kB Details

Built distribution (wheel)

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

Total release size: 886.7 kB

Release files / ui_design_workbench_cli-0.6.6.tar.gz

Download URL ui_design_workbench_cli-0.6.6.tar.gz
Size 310.0 kB
Tags Source
SHA-256 checksum
How to use checksums
2222fb0f739c380e119b8b623c32a4a584fe50af7a7c8b31e5eac1e856d26510
BLAKE2b-256 checksum
How to use checksums
8b0e6e1427c3878238ef902eb9355330d91390a9bccb29ba1597230ce0977528
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 31, 2026.

Transparency log

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

Download URL ui_design_workbench_cli-0.6.6-py3-none-any.whl
Size 576.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e90a3d1ae0c7124bfb18ec3860ae2190ac9dfe53301f14d59a4205b79b8686e2
BLAKE2b-256 checksum
How to use checksums
bc1043eab507213f11907af48f000fd0a18df0a019ebf268859100ed6ab6b838
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 31, 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

This release

0.6.6 This release

2 release files

0.6.3

2 release files

0.5.0

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