uidetox 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. uidetox-0.1.0/AGENTS.md +227 -0
  2. uidetox-0.1.0/LICENSE +21 -0
  3. uidetox-0.1.0/MANIFEST.in +12 -0
  4. uidetox-0.1.0/PKG-INFO +251 -0
  5. uidetox-0.1.0/README.md +225 -0
  6. uidetox-0.1.0/SKILL.md +489 -0
  7. uidetox-0.1.0/commands/adapt.md +199 -0
  8. uidetox-0.1.0/commands/animate.md +190 -0
  9. uidetox-0.1.0/commands/audit.md +129 -0
  10. uidetox-0.1.0/commands/bolder.md +132 -0
  11. uidetox-0.1.0/commands/clarify.md +180 -0
  12. uidetox-0.1.0/commands/colorize.md +158 -0
  13. uidetox-0.1.0/commands/critique.md +118 -0
  14. uidetox-0.1.0/commands/delight.md +317 -0
  15. uidetox-0.1.0/commands/distill.md +137 -0
  16. uidetox-0.1.0/commands/extract.md +95 -0
  17. uidetox-0.1.0/commands/fix.md +78 -0
  18. uidetox-0.1.0/commands/harden.md +358 -0
  19. uidetox-0.1.0/commands/normalize.md +67 -0
  20. uidetox-0.1.0/commands/onboard.md +243 -0
  21. uidetox-0.1.0/commands/optimize.md +269 -0
  22. uidetox-0.1.0/commands/polish.md +202 -0
  23. uidetox-0.1.0/commands/quieter.md +118 -0
  24. uidetox-0.1.0/commands/scan.md +102 -0
  25. uidetox-0.1.0/commands/setup.md +70 -0
  26. uidetox-0.1.0/docs/CLAUDE.md +31 -0
  27. uidetox-0.1.0/docs/CODEX.md +51 -0
  28. uidetox-0.1.0/docs/COPILOT.md +22 -0
  29. uidetox-0.1.0/docs/CURSOR.md +37 -0
  30. uidetox-0.1.0/docs/GEMINI.md +34 -0
  31. uidetox-0.1.0/docs/WINDSURF.md +29 -0
  32. uidetox-0.1.0/pyproject.toml +44 -0
  33. uidetox-0.1.0/reference/anti-patterns.md +116 -0
  34. uidetox-0.1.0/reference/color-and-contrast.md +132 -0
  35. uidetox-0.1.0/reference/color-palettes.md +78 -0
  36. uidetox-0.1.0/reference/creative-arsenal.md +211 -0
  37. uidetox-0.1.0/reference/interaction-design.md +123 -0
  38. uidetox-0.1.0/reference/motion-design.md +99 -0
  39. uidetox-0.1.0/reference/responsive-design.md +114 -0
  40. uidetox-0.1.0/reference/spatial-design.md +100 -0
  41. uidetox-0.1.0/reference/typography.md +131 -0
  42. uidetox-0.1.0/reference/ux-writing.md +107 -0
  43. uidetox-0.1.0/setup.cfg +4 -0
  44. uidetox-0.1.0/uidetox/__init__.py +3 -0
  45. uidetox-0.1.0/uidetox/analyzer.py +227 -0
  46. uidetox-0.1.0/uidetox/cli.py +221 -0
  47. uidetox-0.1.0/uidetox/commands/__init__.py +1 -0
  48. uidetox-0.1.0/uidetox/commands/add_issue.py +37 -0
  49. uidetox-0.1.0/uidetox/commands/autofix.py +42 -0
  50. uidetox-0.1.0/uidetox/commands/check.py +104 -0
  51. uidetox-0.1.0/uidetox/commands/detect.py +58 -0
  52. uidetox-0.1.0/uidetox/commands/exclude.py +17 -0
  53. uidetox-0.1.0/uidetox/commands/format_cmd.py +60 -0
  54. uidetox-0.1.0/uidetox/commands/history_cmd.py +49 -0
  55. uidetox-0.1.0/uidetox/commands/lint.py +86 -0
  56. uidetox-0.1.0/uidetox/commands/loop.py +174 -0
  57. uidetox-0.1.0/uidetox/commands/memory_cmd.py +59 -0
  58. uidetox-0.1.0/uidetox/commands/next.py +110 -0
  59. uidetox-0.1.0/uidetox/commands/plan.py +37 -0
  60. uidetox-0.1.0/uidetox/commands/rescan.py +73 -0
  61. uidetox-0.1.0/uidetox/commands/resolve.py +47 -0
  62. uidetox-0.1.0/uidetox/commands/review.py +20 -0
  63. uidetox-0.1.0/uidetox/commands/scan.py +129 -0
  64. uidetox-0.1.0/uidetox/commands/setup.py +40 -0
  65. uidetox-0.1.0/uidetox/commands/show.py +40 -0
  66. uidetox-0.1.0/uidetox/commands/skill_cmd.py +39 -0
  67. uidetox-0.1.0/uidetox/commands/status.py +147 -0
  68. uidetox-0.1.0/uidetox/commands/subagent_cmd.py +127 -0
  69. uidetox-0.1.0/uidetox/commands/suppress.py +85 -0
  70. uidetox-0.1.0/uidetox/commands/tsc.py +77 -0
  71. uidetox-0.1.0/uidetox/commands/update_skill.py +44 -0
  72. uidetox-0.1.0/uidetox/commands/viz.py +232 -0
  73. uidetox-0.1.0/uidetox/commands/zone.py +128 -0
  74. uidetox-0.1.0/uidetox/history.py +91 -0
  75. uidetox-0.1.0/uidetox/memory.py +112 -0
  76. uidetox-0.1.0/uidetox/state.py +148 -0
  77. uidetox-0.1.0/uidetox/subagent.py +361 -0
  78. uidetox-0.1.0/uidetox/tooling.py +237 -0
  79. uidetox-0.1.0/uidetox/utils.py +8 -0
  80. uidetox-0.1.0/uidetox.egg-info/PKG-INFO +251 -0
  81. uidetox-0.1.0/uidetox.egg-info/SOURCES.txt +83 -0
  82. uidetox-0.1.0/uidetox.egg-info/dependency_links.txt +1 -0
  83. uidetox-0.1.0/uidetox.egg-info/entry_points.txt +2 -0
  84. uidetox-0.1.0/uidetox.egg-info/requires.txt +1 -0
  85. uidetox-0.1.0/uidetox.egg-info/top_level.txt +1 -0
@@ -0,0 +1,227 @@
1
+ # UIdetox
2
+
3
+ An agent harness that eliminates "AI slop" from frontend code and enforces quality across frontend, backend, and database layers. It combines design taste enforcement, anti-pattern detection, mechanical linting, and structured remediation into a repeatable scan→fix loop.
4
+
5
+ UIdetox merges knowledge from three specialized projects:
6
+ - **taste-skill** — Generative design rules, creative arsenal, motion engine
7
+ - **Uncodixfy** — Anti-AI-aesthetic pattern catalog
8
+ - **impeccable** — Design commands, references, and quality workflows
9
+
10
+ ## 1. Philosophy
11
+
12
+ AI-generated UI has a recognizable aesthetic: Inter font, purple-blue gradients, glassmorphism cards, hero metric dashboards, bounce animations, gray text on colored backgrounds. These patterns emerge because LLMs follow the path of least resistance through their training data.
13
+
14
+ UIdetox fights that bias. Its instructions teach the agent what NOT to do (anti-patterns), what TO do instead (design engineering), and HOW to apply fixes systematically (the loop).
15
+
16
+ The goal is frontend code that makes someone ask "how was this made?" — not "which AI made this?"
17
+
18
+ ## 2. The Loop
19
+
20
+ Run `uidetox scan` on the project. The scan auto-detects tooling (TypeScript, biome/eslint/prettier, backend frameworks, database ORMs, API layers) and guides the agent through four steps:
21
+
22
+ **Step 1 — Mechanical Checks:** Run `uidetox check` to execute tsc → lint → format in sequence. Errors are automatically queued as T1 issues.
23
+
24
+ **Step 1.5 — Static Slop Analysis:** A 18-rule deterministic analyzer scans all frontend files for known AI anti-patterns (glassmorphism, purple-blue gradients, bounce animations, oversized shadows, gray-on-color text, missing dark mode, etc.). Detected violations are auto-queued with appropriate tiers.
25
+
26
+ **Step 2 — Design Audit:** The agent reads frontend files and evaluates against SKILL.md. For each issue found:
27
+ `uidetox add-issue --file <path> --tier <T1-T4> --issue <description> --fix-command <command>`
28
+
29
+ **Step 3 — Full-Stack Integration:** If backend/database/API layers are detected, the agent checks for DTO mismatches, schema misalignment, missing error states, and type safety gaps across boundaries.
30
+
31
+ The issues cover:
32
+ - TypeScript compilation errors
33
+ - Lint and formatting violations
34
+ - Anti-pattern detection (AI slop fingerprints)
35
+ - Typography audit
36
+ - Color and contrast review
37
+ - Layout and spacing analysis
38
+ - Motion and interaction quality
39
+ - Responsiveness
40
+ - Accessibility
41
+ - Frontend→Backend→Database integration
42
+ - Code quality
43
+
44
+ The scan generates a prioritized issue list. Issues are tiered:
45
+ - **T1**: Quick fix (font swap, color replacement, spacing adjustment)
46
+ - **T2**: Targeted refactor (component pattern replacement, state additions)
47
+ - **T3**: Design judgment call (layout restructure, interaction rethinking)
48
+ - **T4**: Major redesign (full section or page overhaul)
49
+
50
+ ### Phase 2: Plan — decide what to fix first
51
+
52
+ Run `uidetox plan` to view the queue. The recommended fix order:
53
+
54
+ 1. Font swap — biggest instant improvement, lowest risk
55
+ 2. Color palette cleanup — remove clashing or oversaturated colors
56
+ 3. Hover and active states — makes the interface feel alive
57
+ 4. Layout and spacing — proper grid, max-width, consistent padding
58
+ 5. Replace generic components — swap cliché patterns for modern alternatives
59
+ 6. Add loading, empty, and error states — makes it feel finished
60
+ 7. Polish typography scale and spacing — the premium final touch
61
+
62
+ ### Phase 3: Execute — fix issues file by file
63
+
64
+ Run `uidetox next`. The CLI batches all pending issues for the highest-priority file and injects relevant SKILL.md design rules directly into the output.
65
+ 1. Read the file and all issues listed
66
+ 2. Follow the injected SKILL.md context rules for each issue type
67
+ 3. Fix ALL issues in one pass
68
+ 4. Verify the fixes don't break functionality
69
+ 5. Run `uidetox resolve <issue_id> --note "what you changed"` for each issue
70
+ 6. Run `uidetox next` to loop (self-propagating).
71
+
72
+ Use the design skills directly from the CLI for targeted work:
73
+ - `uidetox normalize <target>` for design system alignment
74
+ - `uidetox polish <target>` for final quality pass
75
+ - `uidetox animate <target>` for motion work
76
+ - `uidetox colorize <target>` for color introduction
77
+ - `uidetox harden <target>` for edge cases and resilience
78
+ - `uidetox distill <target>` for simplification
79
+ - See full command list below
80
+
81
+ ### Phase 4: Verify — confirm improvement
82
+
83
+ Run `uidetox rescan` to clear old issues and re-audit the project. `rescan` automatically runs the 18-rule static slop analyzer and queues any detected anti-patterns before the agent begins its fresh design audit. Run `uidetox status` to see your Design Score. The interface should now:
84
+ - Pass the AI Slop Test (no obvious AI tells)
85
+ - Have consistent typography with intentional font choices
86
+ - Use a cohesive, non-generic color palette
87
+ - Have proper interaction states (hover, focus, active, loading, error, empty)
88
+ - Be responsive and accessible
89
+ - Feel designed, not generated
90
+
91
+ ## 3. Skills
92
+
93
+ The combined SKILL.md contains the full design knowledge base. It is structured as:
94
+
95
+ | Section | Source | Purpose |
96
+ |---------|--------|---------|
97
+ | Design Direction | impeccable | Bold aesthetic commitment |
98
+ | Design Engineering | taste-skill | Bias-correcting rules (typography, color, layout, materiality, states) |
99
+ | Anti-Pattern Catalog | Uncodixfy + impeccable + taste-skill | Comprehensive list of banned AI UI patterns |
100
+ | Creative Arsenal | taste-skill | Advanced design concepts for premium output |
101
+ | Motion Engine | taste-skill | Perpetual micro-interaction framework |
102
+ | Output Enforcement | taste-skill | Anti-laziness rules for complete code generation |
103
+ | Redesign Protocol | taste-skill | Audit-first upgrade workflow |
104
+ | Color Palettes | Uncodixfy | Curated dark/light color schemes |
105
+
106
+ Reference files in `reference/` provide deep-dive guidance for each design domain.
107
+
108
+ ## 4. Commands
109
+
110
+ ### Python CLI Commands (the loop engine)
111
+
112
+ | Command | Purpose |
113
+ |---------|---------|
114
+ | `uidetox setup` | Initialize project config and design dials (use `--auto-commit` to enable Git tracking) |
115
+ | `uidetox scan` | Full audit: auto-detect tooling → static analyzer → design review |
116
+ | `uidetox detect` | Auto-discover linters, formatters, tsc, backend, database, API |
117
+ | `uidetox check` | Run tsc → lint → format in sequence, queue errors as T1 (use `--fix` to auto-solve) |
118
+ | `uidetox tsc` | Run TypeScript compiler, parse and queue errors |
119
+ | `uidetox lint` | Run detected linter (biome/eslint), parse and queue errors |
120
+ | `uidetox format` | Run detected formatter (biome/prettier), auto-fix with --fix |
121
+ | `uidetox add-issue` | Queue a detected issue with tier and fix command |
122
+ | `uidetox plan` | View and reorder the issue queue by priority |
123
+ | `uidetox next` | Batch issues for top-priority file with SKILL.md context injection |
124
+ | `uidetox resolve <id> --note "..."` | Mark an issue as fixed (note is mandatory) |
125
+ | `uidetox loop` | Enter autonomous self-propagation fix loop |
126
+ | `uidetox loop --orchestrator` | Sub-agent mode with auto-parallel (1-5) and memory injection |
127
+ | `uidetox subagent` | Manage sub-agent sessions and generate stage prompts |
128
+ | `uidetox memory` | Read/write persistent agent memory (patterns, notes, reviewed files) |
129
+ | `uidetox history` | View run history and score progression (use `--full` for deep inspection) |
130
+ | `uidetox status` | Health dashboard with Design Score (1-100) (use `--json` for automation) |
131
+ | `uidetox show [pattern]` | Filter/inspect issues by file, tier, or ID |
132
+ | `uidetox autofix` | Batch all safe T1 fixes for the agent to apply (use `--dry-run` to preview only) |
133
+ | `uidetox rescan` | Clear queue, run 18-rule static analyzer, re-audit from scratch |
134
+ | `uidetox exclude <path>` | Skip a directory during scanning |
135
+ | `uidetox review` | Prompt a subjective UX quality review |
136
+ | `uidetox update-skill <agent>` | Install SKILL.md to claude/cursor/gemini/codex |
137
+ | `uidetox viz` | Generate an HTML heatmap of codebase issues |
138
+ | `uidetox tree` | Print a terminal tree of codebase issue density |
139
+ | `uidetox zone` | Show/set/clear file zone classifications (production, test, vendor, etc.) |
140
+ | `uidetox suppress` | Permanently silence issues matching a pattern |
141
+
142
+ ### Slash Commands (design skills — natively executable via CLI)
143
+
144
+ | Command | Purpose |
145
+ |---------|---------|
146
+ | `uidetox audit [target]` | Technical quality checks (a11y, perf, theming, responsive) |
147
+ | `uidetox critique [target]` | UX design review (hierarchy, emotion, composition) |
148
+ | `uidetox normalize [target]` | Align with design system standards |
149
+ | `uidetox polish [target]` | Final pre-ship quality pass |
150
+ | `uidetox distill [target]` | Strip to essence, remove complexity |
151
+ | `uidetox clarify [target]` | Improve unclear UX copy |
152
+ | `uidetox optimize [target]` | Performance improvements |
153
+ | `uidetox harden [target]` | Error handling, i18n, edge cases |
154
+ | `uidetox animate [target]` | Add purposeful motion |
155
+ | `uidetox colorize [target]` | Introduce strategic color |
156
+ | `uidetox bolder [target]` | Amplify boring designs |
157
+ | `uidetox quieter [target]` | Tone down overly bold designs |
158
+ | `uidetox delight [target]` | Add moments of joy |
159
+ | `uidetox extract [target]` | Pull into reusable components |
160
+ | `uidetox adapt [target]` | Adapt for different devices |
161
+ | `uidetox onboard [target]` | Design onboarding flows |
162
+
163
+ Slash commands are dynamically loaded from `commands/*.md` and accept an optional target argument (e.g., `uidetox audit src/components/`, `uidetox polish checkout-form`).
164
+
165
+ ## 5. Configuration
166
+
167
+ The harness supports three design dials that control output aesthetic:
168
+
169
+ **DESIGN_VARIANCE** (1-10) — How experimental the layout is.
170
+ - 1-3: Clean, centered, standard grids
171
+ - 4-7: Overlapping elements, varied sizes, offset margins
172
+ - 8-10: Asymmetric, masonry, massive whitespace zones
173
+
174
+ **MOTION_INTENSITY** (1-10) — How much animation.
175
+ - 1-3: CSS hover/active states only
176
+ - 4-7: Fade-ins, smooth transitions, staggered entry
177
+ - 8-10: Scroll-triggered reveals, spring physics, magnetic effects
178
+
179
+ **VISUAL_DENSITY** (1-10) — How much content per screen.
180
+ - 1-3: Art gallery mode, spacious, luxury feel
181
+ - 4-7: Standard web app spacing
182
+ - 8-10: Cockpit mode, dense data, monospace numbers
183
+
184
+ Default baseline: `(8, 6, 4)`. Override via `/setup` or direct instruction.
185
+
186
+ ## 6. Provider Installation
187
+
188
+ UIdetox supports tailored integration with all major AI coding platforms.
189
+
190
+ Run `uidetox update-skill <agent>` (choices: `claude`, `cursor`, `gemini`, `codex`, `windsurf`, `copilot`) to receive exact configuration instructions and setup commands.
191
+
192
+ UIdetox reads from its `docs/` catalog to output platform-specific workflows, covering native rules (like `.cursor/rules/`), system memory integrations, and specific prompt structures.
193
+
194
+ ## 7. Repository Structure
195
+
196
+ ```
197
+ UIdetox/
198
+ ├── pyproject.toml # Python packaging
199
+ ├── AGENTS.md # This file — master agent entry point
200
+ ├── SKILL.md # Combined design skill (all three repos)
201
+ ├── README.md # User documentation + quick-start prompt
202
+ ├── uidetox/ # Python CLI package
203
+ │ ├── cli.py # Argparse router (30+ commands, dynamic slash-command loading)
204
+ │ ├── state.py # Issue queue + config in .uidetox/
205
+ │ ├── tooling.py # Auto-detection (tsc, biome, eslint, NestJS, etc.)
206
+ │ ├── analyzer.py # 18-rule static slop detector (deterministic anti-pattern scan)
207
+ │ ├── history.py # Run snapshot storage and progression tracking
208
+ │ ├── memory.py # Persistent agent memory (reviewed files, patterns, notes)
209
+ │ ├── subagent.py # Sub-agent session infrastructure (5-stage pipeline)
210
+ │ └── commands/ # Command implementations
211
+ │ ├── scan.py, next.py, resolve.py, plan.py
212
+ │ ├── setup.py, review.py, update_skill.py
213
+ │ ├── status.py, show.py, autofix.py, loop.py
214
+ │ ├── exclude.py, rescan.py, add_issue.py
215
+ │ ├── detect.py, check.py, tsc.py, lint.py, format_cmd.py
216
+ │ ├── subagent_cmd.py, history_cmd.py
217
+ │ ├── memory_cmd.py, skill_cmd.py
218
+ │ ├── viz.py, zone.py, suppress.py
219
+ ├── commands/ # Slash commands (19 total, dynamically loaded by CLI)
220
+ │ ├── scan.md, fix.md, setup.md
221
+ │ ├── audit.md, critique.md, normalize.md, ...
222
+ ├── reference/ # Deep-dive design references
223
+ │ ├── anti-patterns.md, color-palettes.md, creative-arsenal.md
224
+ │ ├── typography.md, color-and-contrast.md, ...
225
+ ├── .agents/workflows/
226
+ │ └── detox.md # Guided workflow
227
+ ```
uidetox-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 artmanuky
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,12 @@
1
+ include README.md
2
+ include SKILL.md
3
+ include AGENTS.md
4
+ include LICENSE
5
+ recursive-include commands *.md
6
+ recursive-include reference *.md
7
+ recursive-include docs *.md
8
+
9
+ # Exclude generated directories from package
10
+ prune .uidetox
11
+ prune .claude
12
+ global-exclude *.egg-info
uidetox-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,251 @@
1
+ Metadata-Version: 2.4
2
+ Name: uidetox
3
+ Version: 0.1.0
4
+ Summary: Agent harness and CLI to eliminate AI slop from frontend code
5
+ Author: artmanuky
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/Naustudents22/UIdetox
8
+ Project-URL: Repository, https://github.com/Naustudents22/UIdetox
9
+ Project-URL: Issues, https://github.com/Naustudents22/UIdetox/issues
10
+ Keywords: code-quality,frontend,design,ai-slop,agent,cli
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Environment :: Console
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: MIT License
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Topic :: Software Development :: Quality Assurance
20
+ Classifier: Topic :: Software Development :: Build Tools
21
+ Requires-Python: >=3.11
22
+ Description-Content-Type: text/markdown
23
+ License-File: LICENSE
24
+ Requires-Dist: PyYAML>=6.0
25
+ Dynamic: license-file
26
+
27
+ # UIdetox
28
+
29
+ > An agent harness that eliminates "AI slop" from frontend code.
30
+
31
+ UIdetox gives your AI coding agent the instructions to identify, understand, and systematically fix generic AI-generated UI. It combines design taste enforcement, anti-pattern detection, and structured remediation into a repeatable scan→fix loop.
32
+
33
+ The goal: frontend code that makes someone ask "how was this made?" — not "which AI made this?"
34
+
35
+ ## For your agent's consideration...
36
+
37
+ Paste this prompt into your agent:
38
+
39
+ ```
40
+ I want you to eliminate AI slop from this codebase and make the UI indistinguishable from
41
+ hand-crafted design. To do this, install and run UIdetox.
42
+ Run ALL of the following (requires Python 3.11+):
43
+
44
+ pip install -e .
45
+ uidetox update-skill claude # installs the full design skill — pick yours: claude, cursor, gemini, codex, windsurf, copilot
46
+ uidetox setup # initialize design dials (DESIGN_VARIANCE, MOTION_INTENSITY, VISUAL_DENSITY)
47
+
48
+ Before scanning, exclude directories that should be skipped (vendor, build output, generated
49
+ code, node_modules, dist) with `uidetox exclude <path>`. Check `uidetox zone show` to verify
50
+ file classifications. Share anything questionable with me before excluding.
51
+
52
+ uidetox scan --path .
53
+ uidetox next
54
+
55
+ --path is the directory to scan (use "." for the whole project, or "src/" etc).
56
+
57
+ Your goal is to get the Design Score as high as possible. The scoring is weighted across
58
+ typography, color, layout, motion, states, accessibility, and full-stack integration — the
59
+ only way to improve it is to actually make the interface better.
60
+
61
+ THE LOOP: run `next`. It batches all pending issues for the highest-priority file so you fix
62
+ files holistically, not one issue at a time. Each batch includes relevant SKILL.md design
63
+ rules injected automatically — follow them, don't substitute your own analysis. Fix all
64
+ issues in the batch, resolve each with:
65
+ uidetox resolve <ID> --note "what you changed"
66
+ The --note is mandatory — you must explain what you did. Then run `next` again. Over and over.
67
+ When the queue empties, run `uidetox rescan` to re-audit with fresh eyes. `rescan` runs an
68
+ 18-rule static slop analyzer automatically, catching glassmorphism, purple-blue gradients,
69
+ bounce animations, oversized shadows, missing dark mode, generic copy, and more. Keep looping
70
+ until `uidetox status` shows Score >= 95 and zero pending issues. Do NOT stop before that.
71
+
72
+ For safety during autonomous loops, enable auto-commit:
73
+ uidetox setup --auto-commit
74
+ This makes every `uidetox resolve` atomically commit the fixed file to git, creating a clean
75
+ patch history you can review or rollback. Highly recommended for orchestrator mode.
76
+
77
+ Don't be lazy. Large redesigns and small detail fixes — do both with equal energy. No task
78
+ is too big or too small. Replace entire components if they reek of AI slop. Rewrite files
79
+ from scratch if the structure is unsalvageable. Fix things properly, not minimally.
80
+
81
+ Use `plan` to reorder priorities or cluster related issues. Use `uidetox tree` to see where
82
+ issues concentrate. Use `uidetox viz` to generate a visual heatmap. Rescan periodically.
83
+
84
+ For targeted design work, use the slash commands directly from the CLI:
85
+ uidetox polish src/Header.tsx # final quality pass
86
+ uidetox audit src/components/ # technical a11y/perf/theming checks
87
+ uidetox critique src/pages/ # UX design review
88
+ uidetox harden src/forms/ # error handling, i18n, edge cases
89
+ uidetox animate src/hero/ # add purposeful motion
90
+ All 16 design skills (audit, critique, normalize, polish, distill, harden, animate, colorize,
91
+ bolder, quieter, delight, extract, adapt, onboard, clarify, optimize) are available as native
92
+ CLI commands. Each loads its full design ruleset and targets the file or directory you specify.
93
+
94
+ For complex passes, use orchestrator mode: `uidetox loop --orchestrator`. This breaks work
95
+ into five sub-agent stages (observe → diagnose → prioritize → fix → verify), each with an
96
+ isolated prompt generated by `uidetox subagent --stage-prompt <stage>`. The orchestrator
97
+ automatically calculates optimal parallelism (1-5 agents) based on queue spread and injects
98
+ all saved memory context into the bootstrap. Launch sub-agents concurrently. Record
99
+ completions with `uidetox subagent --record`.
100
+
101
+ The agent memory persists across sessions. Save architectural decisions you discover:
102
+ uidetox memory pattern "This project uses Radix UI, not shadcn"
103
+ uidetox memory note "Custom SVG icon set in src/icons/, don't use lucide"
104
+ View memory with `uidetox memory show`. Clear with `uidetox memory clear`. What you learn
105
+ about this codebase stays in `.uidetox/memory.json` and is automatically injected into every
106
+ `uidetox loop` invocation so you never repeat mistakes or revert prior decisions.
107
+ History of every scan lives in `.uidetox/history/`.
108
+
109
+ If you have access to MCP servers, filesystem tools, or browser automation — use them.
110
+ Read files directly. Run terminal commands. Open the app in a browser and verify visually.
111
+ You are not a chatbot suggesting changes. You are an operator grinding through a queue until
112
+ this codebase is unrecognizable from its AI-generated origin.
113
+ ```
114
+
115
+ ## From Vibe Coding to Vibe Design
116
+
117
+ Vibe coding gets things built fast. But the interfaces it produces have a smell — Inter font, purple-blue gradients, glassmorphism cards, bounce animations, hero metric dashboards. These patterns emerge because LLMs follow the path of least resistance through their training data. The result is an interface that *works*, but screams "AI made this" to anyone who's seen enough of them.
118
+
119
+ The core bet here is that an LLM with the right constraints can hold a frontend to a standard that used to require a senior designer paying close attention. Not by generating more of the same, but by knowing what *not* to do — and having a systematic loop to enforce it.
120
+
121
+ UIdetox defines what "designed" looks like as a Design Score worth optimizing. Not a lint score you game by suppressing warnings. Something where improving the number means the interface genuinely got better — better typography, better color, better states, better motion. The anti-slop rules are the difference between a useful signal and a vanity metric.
122
+
123
+ The hope is that anyone can use AI to build something a seasoned designer would look at and respect. That's the bar.
124
+
125
+ ## Installation
126
+
127
+ ### Cursor
128
+ Copy `AGENTS.md`, `SKILL.md`, `commands/`, and `reference/` into your project root.
129
+
130
+ > **Note:** Cursor Agent Skills require Nightly channel. Enable in Settings → Beta, then enable Agent Skills in Settings → Rules.
131
+
132
+ ### Claude Code
133
+ ```bash
134
+ # Project-specific
135
+ cp AGENTS.md SKILL.md your-project/
136
+ cp -r commands/ reference/ your-project/
137
+
138
+ # Or copy into .claude/skills/
139
+ mkdir -p your-project/.claude/skills/uidetox
140
+ cp SKILL.md your-project/.claude/skills/uidetox/
141
+ cp -r reference/ your-project/.claude/skills/uidetox/
142
+ ```
143
+
144
+ ### Gemini CLI
145
+ ```bash
146
+ cp SKILL.md your-project/
147
+ # Reference in GEMINI.md:
148
+ echo '@./SKILL.md' >> your-project/GEMINI.md
149
+ ```
150
+
151
+ ### Codex CLI
152
+ ```bash
153
+ mkdir -p ~/.codex/skills/uidetox
154
+ cp SKILL.md ~/.codex/skills/uidetox/
155
+ cp -r reference/ ~/.codex/skills/uidetox/
156
+ cp -r commands/ ~/.codex/prompts/
157
+ ```
158
+
159
+ ## Commands
160
+
161
+ ### CLI Commands (the loop engine)
162
+
163
+ | Command | Purpose |
164
+ |---------|---------|
165
+ | `uidetox scan` | Full audit: auto-detect tooling → static analyzer → design review |
166
+ | `uidetox check` | Run tsc → lint → format in sequence, queue errors as T1 (`--fix` to auto-solve) |
167
+ | `uidetox next` | Batch issues for the top-priority file with SKILL.md context injection |
168
+ | `uidetox resolve <id> --note "..."` | Mark an issue as fixed (note is mandatory) |
169
+ | `uidetox loop` | Enter autonomous fix loop until target score is reached |
170
+ | `uidetox loop --orchestrator` | Sub-agent mode with auto-parallel (1-5 agents) and memory injection |
171
+ | `uidetox status` | Health dashboard with Design Score (`--json` for automation payload) |
172
+ | `uidetox plan` | Reorder the issue queue by priority |
173
+ | `uidetox autofix` | Batch-apply all safe T1 quick fixes (`--dry-run` to preview only) |
174
+ | `uidetox memory` | Read/write persistent agent memory (patterns, notes) |
175
+ | `uidetox tree` | Terminal tree of issue density |
176
+ | `uidetox viz` | HTML heatmap of the codebase |
177
+ | `uidetox history` | Score progression across runs (`--full` for details) |
178
+ | `uidetox zone` | Show/set/clear file zone classifications |
179
+ | `uidetox suppress` | Permanently silence false positive patterns |
180
+ | `uidetox subagent` | Manage sub-agent sessions and prompts |
181
+ | `uidetox detect` | Auto-discover linters, formatters, backends, databases, APIs |
182
+ | `uidetox rescan` | Clear queue, run 18-rule static analyzer, re-audit from scratch |
183
+
184
+ ### Slash Commands (design skills)
185
+
186
+ All slash commands are now **natively executable from the CLI** — no need to read `.md` files manually:
187
+
188
+ | Command | Purpose |
189
+ |---------|---------|
190
+ | `uidetox audit [target]` | Technical quality checks (a11y, perf, theming, responsive) |
191
+ | `uidetox critique [target]` | UX design review (hierarchy, emotion, composition) |
192
+ | `uidetox normalize [target]` | Align with design system standards |
193
+ | `uidetox polish [target]` | Final pre-ship quality pass |
194
+ | `uidetox distill [target]` | Strip to essence, remove complexity |
195
+ | `uidetox clarify [target]` | Improve unclear UX copy |
196
+ | `uidetox optimize [target]` | Performance improvements |
197
+ | `uidetox harden [target]` | Error handling, i18n, edge cases |
198
+ | `uidetox animate [target]` | Add purposeful motion |
199
+ | `uidetox colorize [target]` | Introduce strategic color |
200
+ | `uidetox bolder [target]` | Amplify boring designs |
201
+ | `uidetox quieter [target]` | Tone down overly bold designs |
202
+ | `uidetox delight [target]` | Add moments of joy |
203
+ | `uidetox extract [target]` | Pull into reusable components |
204
+ | `uidetox adapt [target]` | Adapt for different devices |
205
+ | `uidetox onboard [target]` | Design onboarding flows |
206
+
207
+ Target can be a file, directory, or component name:
208
+ ```
209
+ uidetox audit src/components/
210
+ uidetox polish src/Header.tsx
211
+ uidetox animate src/hero/
212
+ ```
213
+
214
+ ## Configuration
215
+
216
+ Three design dials control output aesthetic (default: 8, 6, 4):
217
+
218
+ | Dial | Low (1-3) | Mid (4-7) | High (8-10) |
219
+ |------|-----------|-----------|-------------|
220
+ | **DESIGN_VARIANCE** | Clean, centered, standard grids | Overlapping, varied sizes | Asymmetric, masonry, massive whitespace |
221
+ | **MOTION_INTENSITY** | CSS hover/active only | Fade-ins, smooth transitions | Scroll reveals, spring physics, magnetic effects |
222
+ | **VISUAL_DENSITY** | Art gallery, spacious | Standard web app | Cockpit mode, dense data |
223
+
224
+ Override by editing `SKILL.md` or telling your agent directly: "Set DESIGN_VARIANCE to 3."
225
+
226
+ ## The AI Slop Test
227
+
228
+ If you showed this interface to someone and said "AI made this," would they believe you immediately? If yes, that's the problem.
229
+
230
+ UIdetox trains your agent to avoid the telltale patterns:
231
+ - Inter font everywhere
232
+ - Purple-blue gradients
233
+ - Card grids with identical layouts
234
+ - Glassmorphism panels
235
+ - Hero metric dashboards
236
+ - Bounce animations
237
+ - Gray text on colored backgrounds
238
+ - Generic startup copy
239
+
240
+ ## Credits
241
+
242
+ UIdetox combines knowledge from:
243
+ - [taste-skill](https://github.com/Leonxlnx/taste-skill) by [@lexnlin](https://x.com/lexnlin) — Design dials, creative arsenal, motion engine, output enforcement
244
+ - [Uncodixfy](https://github.com/cyxzdev/Uncodixfy) — Anti-AI-aesthetic pattern catalog, curated color palettes
245
+ - [impeccable](https://github.com/pbakaus/impeccable) by [Paul Bakaus](https://www.paulbakaus.com) — Frontend design skill, 17 commands, domain references
246
+
247
+ Inspired by [desloppify](https://github.com/peteromallet/desloppify) by Pete O'Mallet.
248
+
249
+ ## License
250
+
251
+ See individual source repositories for their respective licenses.