UI Design Workbench
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
- Changelog
- Agent integrations
- Fidelity contract
- Native rendering
- Cache protocol
- Platform component catalog
- IR schema
- Review workflow
Current CLI version: 0.6.3.
1 maintainer
Metadata
1 maintainer
Release files for ui-design-workbench-cli 0.6.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ui_design_workbench_cli-0.6.3.tar.gz | 293.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ui_design_workbench_cli-0.6.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 837.1 kB
Release files / ui_design_workbench_cli-0.6.3.tar.gz
| Download URL | ui_design_workbench_cli-0.6.3.tar.gz |
|---|---|
| Size | 293.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
24f2573ca3024230a1b0190522813d874b6422700236e21dcb3f4b270aaf9682
|
|
BLAKE2b-256 checksum How to use checksums |
717c0df741e20e7d7bbe10edac40df1ffb402bea8d7e5e8825eb3fb6b55bea5c
|
| 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 logRelease files / ui_design_workbench_cli-0.6.3-py3-none-any.whl
| Download URL | ui_design_workbench_cli-0.6.3-py3-none-any.whl |
|---|---|
| Size | 543.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
18910ea7e87d5c9defcebb9a0862a83279d09a4dad1eb54e2ac24e5f950f8917
|
|
BLAKE2b-256 checksum How to use checksums |
f0cbe91980601ed23c25974efc91c0fdce5f0544a878ba20452a4b58b1a59783
|
| 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
