About this project

# ux-skill — Design Intelligence Engine for AI Coding Tools ux-skill is a **design intelligence engine** designed to make AI-generated UI distinctive instead of generic. It integrates with 17 AI coding tools including Claude Code, Cursor, Windsurf, GitHub Copilot, Gemini CLI, Codex, and others. The engine is free, MIT-licensed, works offline, and never calls an LLM. ## Key Features - **Deterministic 7-axis synthesizer**: Compiles briefs into fresh design tokens (warmth, contrast, density, geometry, formality, motion, type personality) without picking from templates. - **152 anti-AI-slop linter rules**: Deterministic regex-based rules that run in CI and exit non-zero on Critical/High issues. - **160 brand specs**: Real DESIGN.md specs for brands like Apple, Stripe, Linear, Figma, Tesla, BMW, Notion, Spotify, Airbnb, Vercel, Supabase, Cursor, Raycast, Claude, and more. - **12 queryable JSON manifests**: 84 styles, 176 palettes, 70 type pairings, 148 components, 184 industries, 35 chart types, 57 motion presets, 112 UX laws, 152 anti-pattern rules, 25 tech stacks, and 160 brand specs. - **25 slash commands**: Discovery, generation, audit, lint, polish, fix loop, case-study, workshop, copy, motion, a11y, dashboard, and conductor commands. - **5 sub-agents**: Frontend engineer, motion engineer, copy writer, research synthesizer, and design system architect. - **18 MCP tools**: Including ux_synthesize, ux_decisions_query, and ux_decisions_stats. - **17 IDE support**: Same engine with different glue per IDE. - **Offline and deterministic**: No LLM calls, same input always produces the same output. ## Installation Three install paths are available: ### Path 1 — Claude Code marketplace (canonical) ```bash /plugin marketplace add Laith0003/ux-skill /plugin install ux@ux-skill ``` ### Path 2 — pip (universal) ```bash pip install uxskill uxskill init # auto-detects your IDE, installs the right artifact uxskill stats # print manifest counts to verify install uxskill lint . # run the linter against the current directory ``` ### Path 3 — npx (no Python required) ```bash npx uxskill init # downloads pipx + uxskill on first run npx uxskill recommend --industry=fintech-neobank --tone=warm --stack=nextjs-15-app-router ``` ## How It Works 1. **Input**: Provide a brief via `/ux-discover` (10 fields) or flags to `ux recommend`. 2. **5 parallel searches**: The engine runs five lookups concurrently across manifests (industry, style, tone, stack, forbidden/region). 3. **Merge**: A deterministic merger ranks candidates and resolves conflicts. 4. **Output**: A JSON document with style, palette, type pair, motion presets, components, brand exemplars, and anti-pattern guardrails. 5. **Generation**: Downstream commands consume the recommendation to generate code via sub-agents. 6. **Verification**: `/ux-lint` re-scans generated code against 152 regex rules. ## v3.1.0 Highlights - **Brand fidelity enforced**: Primary color read from logo pixels, default fonts rejected, hard floor in evaluate that fails outputs dropping brand color/logo or shipping no real imagery. - **Mobile-first gated**: New craft foundations plus a wrap-aware gate that fails on horizontal scroll, wrapping nav/wordmark/button label, or over-tall sticky header. - **Wow layer**: Engine derives 2-3 coordinated signature moments per page. - **Sharper linter**: 152 rules including imagery-mandatory, icon-only detection, placeholder-token and 100vw rules. - **310 passing tests**: Offline, deterministic, no LLM ever called. ## Architecture The engine consists of: - **data/**: Queryable JSON manifests (styles, palettes, type pairs, components, industries, chart types, tech stacks, UX guidelines, motion presets, anti-patterns, brands). - **engine/**: Python reasoning core (synthesizer, decisions, recommender, linter, discovery, generator, installer, CLI). - **commands/**: 25 Claude Code slash commands (.md files). - **agents/**: 5 sub-agents (.md files). - **references/**: Prose source for data and demo pages. - **bin/**: npx wrapper and linter scripts. - **.ux/**: Per-project state directory. ## Comparison The README includes an honest comparison against 8 other Claude UX plugins, noting where ux-skill wins (component library, motion presets, anti-pattern linter, brand specs, 17 IDE support, 25 slash commands) and where it loses (awareness, brand recognition, marketing polish). ## License MIT License. Author: Laith Aljunaidy, designer and CTO in Amman. Site: uxskill.laithjunaidy.com. GitHub: Laith0003/ux-skill. PyPI: uxskill. npm: uxskill.