## File: README.md # [UI UX Pro Max](https://uupm.cc) An AI skill that provides design intelligence for building professional UI/UX across multiple platforms and frameworks. ## What's New in v2.0 ### Intelligent Design System Generation The flagship feature of v2.0 is the **Design System Generator** - an AI-powered reasoning engine that analyzes your project requirements and generates a complete, tailored design system in seconds. ``` /* Detailed source-code truncated for AI context efficiency. */ ``` ### How Design System Generation Works ``` /* Detailed source-code truncated for AI context efficiency. */ ``` ### 192 Industry-Specific Reasoning Rules The reasoning engine includes specialized rules for: | Category | Examples | |----------|----------| | **Tech & SaaS** | SaaS, Micro SaaS, B2B Service, Developer Tool / IDE, AI/Chatbot Platform, Cybersecurity Platform | | **Finance** | Fintech/Crypto, Banking, Insurance, Personal Finance Tracker, Invoice & Billing Tool | | **Healthcare** | Medical Clinic, Pharmacy, Dental, Veterinary, Mental Health, Medication Reminder | | **E-commerce** | General, Luxury, Marketplace (P2P), Subscription Box, Food Delivery | | **Services** | Beauty/Spa, Restaurant, Hotel, Legal, Home Services, Booking & Appointment | | **Creative** | Portfolio, Agency, Photography, Gaming, Music Streaming, Photo/Video Editor | | **Lifestyle** | Habit Tracker, Recipe & Cooking, Meditation, Weather, Diary, Mood Tracker | | **Emerging Tech** | Web3/NFT, Spatial Computing, Quantum Computing, Autonomous Drone Fleet | Each rule includes: - **Recommended Pattern** - Landing page structure - **Style Priority** - Best matching UI styles - **Color Mood** - Industry-appropriate palettes - **Typography Mood** - Font personality matching - **Key Effects** - Animations and interactions - **Anti-Patterns** - What NOT to do (e.g., "AI purple/pink gradients" for banking) ## Features - **79 Searchable UI Styles (50 active)** - Glassmorphism, Claymorphism, Minimalism, Brutalism, Neumorphism, Bento Grid, Dark Mode, AI-Native UI, and more - **192 Color Palettes** - Industry-specific palettes aligned 1:1 with the 192 product types - **74 Font Pairings** - Curated typography combinations with Google Fonts imports - **25 Chart Types** - Recommendations for dashboards and analytics - **22 Tech Stacks** - React, Next.js, Astro, Vue, Nuxt.js, Nuxt UI, Svelte, SwiftUI, React Native, Flutter, HTML+Tailwind, shadcn/ui, Jetpack Compose, Angular, Laravel, Three.js, JavaFX, WPF, WinUI 3, UWP, Avalonia, Uno Platform - **119 UX Guidelines** - Best practices, anti-patterns, accessibility rules, resilient text layout, compact labels, and cancellable interactions - **192 Reasoning Rules** - Industry-specific design system generation (NEW in v2.0) ### Resilient Text and Compact UI The guidance now covers common production failures around headings, long tokens, chips, badges, and interrupted micro-interactions: - Balanced heading wrapping is a progressive enhancement, not a guarantee that a specific word will remain on the last line. Designs must still work with natural wrapping across widths, fonts, and locales. - Essential text must reflow without clipping at narrow widths, browser zoom, text scaling, and user spacing overrides. Long URLs and identifiers may wrap safely. - Chip and tag collections should wrap or use an operable `+n` disclosure. A compact label should remain whole when practical; unavoidable truncation needs an accessible full-value path for keyboard, pointer, and touch users. - Badge meaning cannot rely on color alone. Interactive chips need native semantics, visible focus, and programmatic state; live counts need meaningful context. - Rapid interactions may cancel animation, but the final semantic state, focus, and content must remain correct. Timing is selected for the platform and component, with reduced-motion preferences respected. ### Style Taxonomy The catalog contains **79 searchable styles** backed by stable IDs and aliases: | Status | Count | Search behavior | |--------|------:|-----------------| | Active | 50 | Included in normal recommendations and shown by default in the gallery | | Supplemental | 29 | Returned for exact or explicit variant/system intent; available through the gallery status filter | | Deprecated | 9 | Excluded from normal ranking; legacy names redirect to a canonical style or landing pattern | The active set covers 43 general visual families, 2 mobile-specific styles, 3 official platform/design systems, 1 platform material, and 1 core analytics style. Current official systems include Fluent 2, Shopify Polaris, and Adobe Spectrum; Liquid Glass is scoped as an Apple platform material, Material 3 Expressive remains a mobile Material variant, and Spectrum 2 is supplemental. Landing-page structures live in the separate 34-pattern landing dataset rather than competing with visual styles in BM25 ranking. See [`styles.csv`](src/ui-ux-pro-max/data/styles.csv) for the full taxonomy and provenance-aware metadata. ## 💎 Basic vs. Premium Version Comparison Many users ask about the differences between the open-source and premium versions. Here is a detailed breakdown to help you choose the right fit for your workflow. ### 🟢 Basic Version (This Repository) * **Fully Open Source:** Perfect for individual developers, hobbyists, and standard projects. * **Core UI/UX Intelligence:** Full access to 79 searchable UI styles (50 active), 192 product types, color palettes, and curated font pairings. * **Smart Recommendations:** Built-in BM25 search engine for highly accurate design matching. * **Cross-Platform Support:** Stack-specific guidelines supporting 22 major frameworks (React, Vue, Tailwind, iOS, Android, etc.). * **Design System Generation:** Instantly generate tailored UI rules, patterns, and logic via CLI. ### 🟡 Premium Version * **Extended Brand Design Skills:** Goes beyond UI/UX to include Brand Identity generation, Logo Design, Corporate Identity Programs (CIP), Banners, Presentation Slides, and custom Iconography. * **Advanced Asset Creation:** Deep integration with AI-powered image generation to create real visual assets, not just placeholders. * **Enterprise Architecture:** A more comprehensive and scalable Design Token architecture, built for large-scale team deployments. * **Priority Support:** Dedicated technical assistance for teams and professionals who need an uninterrupted full design workflow. 👉 *For more details on upgrading to the Premium tier, visit [uupm.cc](https://uupm.cc).* ## Installation ### Using Claude Marketplace (Claude Code) Install directly in Claude Code with two commands: ``` /plugin marketplace add nextlevelbuilder/ui-ux-pro-max-skill /plugin install ui-ux-pro-max@ui-ux-pro-max-skill ``` ### Using CLI (Recommended) ```bash # Install CLI globally npm install ui-ux-pro-max-cli # Go to your project cd /path/to/your/project # Install for your AI assistant uipro init --ai claude # Claude Code uipro init --ai cursor # Cursor uipro init --ai windsurf # Windsurf uipro init --ai antigravity # Antigravity uipro init --ai copilot # GitHub Copilot uipro init --ai kiro # Kiro uipro init --ai codex # Codex CLI uipro init --ai qoder # Qoder uipro init --ai roocode # Roo Code uipro init --ai gemini # Gemini CLI uipro init --ai trae # Trae uipro init --ai opencode # OpenCode uipro init --ai continue # Continue uipro init --ai codebuddy # CodeBuddy uipro init --ai droid # Droid (Factory) uipro init --ai kilocode # KiloCode uipro init --ai warp # Warp uipro init --ai augment # Augment uipro init --ai codewhale # CodeWhale uipro init --ai universal # Universal / Agent Standard (.agents/skills/) uipro init --ai all # All assistants ``` The npm package is `ui-ux-pro-max-cli`; it still installs the `uipro` command. Older `uipro-cli` releases are stale and should not be used for current assets. ### Global Install (Available for All Projects) ```bash uipro init --ai claude --global # Install to ~/.claude/skills/ uipro init --ai cursor --global # Install to ~/.cursor/skills/ uipro init --ai universal --global # Install to ~/.agents/skills/ ``` ### Other CLI Commands ```bash uipro versions # List available versions uipro update # Refresh skill files from installed CLI package uipro update --global # Refresh global skill files from installed CLI package uipro init --offline # Compatibility flag; installs bundled templates uipro uninstall # Remove skill (auto-detect platform) uipro uninstall --ai claude # Remove specific platform uipro uninstall --global # Remove from global install ``` ## Prerequisites Python 3.x is required for the search script (standard library only — the scripts install nothing and make no network calls). Check if Python is installed: ```bash python3 --version ``` If it is missing, install it yourself from [python.org](https://www.python.org/downloads/) or with your OS package manager (Homebrew, apt, winget). These install steps are for **you, the human user** — AI agents using this skill should never install software on your machine; they are instructed to ask you instead. ## Usage ### Skill Mode (Auto-activate) **Supported:** Claude Code, Cursor, Windsurf, Antigravity, Codex CLI, Continue, Gemini CLI, OpenCode, Qoder, CodeBuddy, Droid (Factory), KiloCode, Warp, Augment, CodeWhale The skill activates automatically when you request UI/UX work. Just chat naturally: ``` Build a landing page for my SaaS product ``` > **Trae**: Switch to **SOLO** mode first. The skill will activate for UI/UX requests. ### Workflow Mode (Slash Command) **Supported:** Kiro, GitHub Copilot, Roo Code, KiloCode Use the slash command to invoke the skill: ``` /ui-ux-pro-max Build a landing page for my SaaS product ``` ### Example Prompts ``` Build a landing page for my SaaS product Create a dashboard for healthcare analytics Design a portfolio website with dark mode Make a mobile app UI for e-commerce Build a fintech banking app with dark theme ``` ### How It Works 1. **You ask** - Request any UI/UX task (build, design, create, implement, review, fix, improve) 2. **Design System Generated** - The AI automatically generates a complete design system using the reasoning engine 3. **Smart recommendations** - Based on your product type and requirements, it finds the best matching styles, colors, and typography 4. **Code generation** - Implements the UI with proper colors, fonts, spacing, and best practices 5. **Pre-delivery checks** - Validates against common UI/UX anti-patterns ### Supported Stacks The skill provides stack-specific guidelines for: | Category | Stacks | |----------|--------| | **Web (HTML)** | HTML + Tailwind (default) | | **React Ecosystem** | React, Next.js, shadcn/ui | | **Vue Ecosystem** | Vue, Nuxt.js, Nuxt UI | | **Angular** | Angular | | **PHP** | Laravel (Blade, Livewire, Inertia.js) | | **Other Web** | Svelte, Astro, Three.js | | **Desktop** | JavaFX, WPF, WinUI 3, Avalonia, Uno Platform, UWP | | **iOS** | SwiftUI | | **Android** | Jetpack Compose | | **Cross-Platform** | React Native, Flutter | Just mention your preferred stack in the prompt, or let it default to HTML + Tailwind. ## Design System Command (Advanced) For direct access to the design system generator: > Note: If you installed via Continue, replace `.claude/skills/` with `.continue/skills/` in the commands below. For Droid (Factory), use `.factory/skills/`. ``` /* Detailed source-code truncated for AI context efficiency. */ ``` Web-stack search is version-aware. Queries without an older major return current, active guidance. Explicit legacy terms or older majors (for example, `Svelte 4` or `Next.js 15`) return only curated legacy rows, labeled by `Status` and `Applies To`; when no matching legacy guidance is curated, search returns no results instead of mixing framework generations. ### Persist Design System (Master + Overrides Pattern) Save your design system to files for **hierarchical retrieval across sessions**: ```bash # Generate and persist to design-system/MASTER.md python3 .claude/skills/ui-ux-pro-max/scripts/search.py "SaaS dashboard" --design-system --persist -p "MyApp" # Also create a page-specific override file python3 .claude/skills/ui-ux-pro-max/scripts/search.py "SaaS dashboard" --design-system --persist -p "MyApp" --page "dashboard" ``` This creates a `design-system/` folder structure: ``` design-system/ ├── MASTER.md # Global Source of Truth (colors, typography, spacing, components) └── pages/ └── dashboard.md # Page-specific overrides (only deviations from Master) ``` **How hierarchical retrieval works:** 1. When building a specific page (e.g., "Checkout"), first check `design-system/pages/checkout.md` 2. If the page file exists, its rules **override** the Master file 3. If not, use `design-system/MASTER.md` exclusively **Context-aware retrieval prompt:** ``` I am building the [Page Name] page. Please read design-system/MASTER.md. Also check if design-system/pages/[page-name].md exists. If the page file exists, prioritize its rules. If not, use the Master rules exclusively. Now, generate the code... ``` ## Architecture & Contributing ### For Users The codebase has been restructured to use a **template-based generation system**. All platform-specific files (`.cursor/`, `.windsurf/`, `.kiro/`, `.factory/`, etc.) are now generated dynamically by the CLI. **Always use the CLI to install:** ```bash npm install ui-ux-pro-max-cli uipro init --ai ``` This ensures you get the latest templates bundled with the installed CLI package and the correct file structure for your AI assistant. Update the npm package first when a new release is published. ### For Contributors If you want to contribute to this project: ```bash # 1. Clone the repository git clone https://github.com/nextlevelbuilder/ui-ux-pro-max-skill.git cd ui-ux-pro-max-skill # 2. Understand the structure src/ui-ux-pro-max/ # Source of truth (data, scripts, templates) cli/ # CLI installer (generates files from templates) .claude/ # Local dev/test for Claude Code skill .factory/ # Local dev/test for Droid (Factory) skill # 3. Make changes in src/ui-ux-pro-max/ # - data/*.csv → Database files # - scripts/*.py → Search engine & design system # - templates/ → Platform-specific templates # 4. Sync to CLI and test locally cd cli npm run sync:assets npm run check:assets npm run verify:data npm run typecheck # 5. Build and test CLI # `npm run build` uses Bun when available and falls back to TypeScript compiler output after `npm ci`. npm run build node dist/index.js init --ai claude --offline # Test in a temp folder # 6. Create PR (never push directly to main) git checkout -b feat/your-feature git commit -m "feat: description" git push -u origin feat/your-feature gh pr create ``` See [CLAUDE.md](CLAUDE.md) for detailed development guidelines. ### Catalog provenance and refresh The committed catalog summary currently records **1,934 approved Google Fonts** plus **8 review exclusions** that are not promoted without matching official license metadata. The icon guidance remains **105 curated rows** (100 direct Phosphor web imports plus React Native/fallback guidance); the separate **1,512-icon upstream Phosphor manifest** validates names, weights, and React/SSR imports without flooding search results with the entire upstream package. Ordinary development and pull-request CI are network-independent. Run the full offline gate, including snapshot hashes and generated count validation, with: ```bash npm --prefix cli run verify:data # Or check only the generated catalog summary: npm --prefix cli run validate:catalog-summary ``` Refresh normalization can also be exercised entirely offline against the committed fixtures. Outputs go to a temporary candidate directory and never replace canonical data: ```bash candidate_dir="$(mktemp -d)" python3 scripts/refresh-google-fonts.py \ --api-input src/ui-ux-pro-max/scripts/tests/fixtures/catalogs/google-api.json \ --metadata-input src/ui-ux-pro-max/scripts/tests/fixtures/catalogs/google-metadata.json \ --existing-csv src/ui-ux-pro-max/scripts/tests/fixtures/catalogs/google-existing.csv \ --overrides src/ui-ux-pro-max/scripts/tests/fixtures/catalogs/google-overrides.json \ --output-csv "$candidate_dir/google-fonts.csv" \ --license-output "$candidate_dir/google-font-licenses.json" \ --metadata-revision fixture-catalogs-v1 \ --verified-at 2026-08-13 --expected-count 2 --approve-changes python3 scripts/refresh-icon-catalog.py \ --input src/ui-ux-pro-max/scripts/tests/fixtures/catalogs/phosphor-core.json \ --package-json src/ui-ux-pro-max/scripts/tests/fixtures/catalogs/phosphor-package.json \ --react-package-json src/ui-ux-pro-max/scripts/tests/fixtures/catalogs/phosphor-react-package.json \ --react-exports-input src/ui-ux-pro-max/scripts/tests/fixtures/catalogs/phosphor-react-exports.json \ --curated-csv src/ui-ux-pro-max/scripts/tests/fixtures/catalogs/icons-curated.csv \ --output "$candidate_dir/phosphor-icons-upstream.json" \ --verified-at 2026-08-13 --expected-count 2 ``` Live upstream refresh is intentionally isolated in the `refresh-catalogs.yml` workflow, scheduled for Mondays at 03:17 UTC and also available on demand. Configure `GOOGLE_FONTS_API_KEY` as a GitHub Actions secret, then run and download its review artifact: ```bash gh workflow run refresh-catalogs.yml run_id="$(gh run list --workflow refresh-catalogs.yml --limit 1 --json databaseId --jq '.[0].databaseId')" gh run watch "$run_id" gh run download "$run_id" --name "catalog-refresh-review-$run_id" ``` The workflow reads the Google Fonts Developer API and pinned official Phosphor packages, writes candidates and unified diffs to an artifact, and has read-only repository permissions. It never commits, pushes, opens a PR, or merges. Review the change reports, exclusions, licenses, relevance metrics, and offline gate before manually promoting candidate files into `src/ui-ux-pro-max/data/`. ## Automated Releases This repository uses semantic-release with Conventional Commits to create GitHub releases automatically: - `dev` branch creates beta GitHub prereleases such as `2.6.0-beta.1`. - `main` branch creates official stable GitHub releases such as `2.6.0`. Release notes and `CHANGELOG.md` are generated from Conventional Commit messages. Version numbers are synchronized across `skill.json`, `.claude-plugin/plugin.json`, `.claude-plugin/marketplace.json`, `cli/package.json`, and `cli/package-lock.json` during release preparation. Use these commit types for correct version bumps: - `fix:` -> patch release - `feat:` -> minor release - `feat!:` or `BREAKING CHANGE:` -> major release The release workflow uses the default `GITHUB_TOKEN` for GitHub releases and the repository `NPM_TOKEN` secret to publish `ui-ux-pro-max-cli` to npm. ## Troubleshooting ### `uipro: unknown command 'uninstall'` or `unknown command 'update'` Your installed version of `ui-ux-pro-max-cli` is outdated. Update it and retry: ```bash npm install ui-ux-pro-max-cli@latest uipro uninstall ``` ### `uipro uninstall` says "No installed AI skill directories detected" The skill was installed in a different directory than where you're running the command. Either: ```bash # Option A — run from the project root where you originally installed it cd /path/to/your/project uipro uninstall # Option B — remove the global install uipro uninstall --global # Option C — remove manually rm -rf .claude/skills/ui-ux-pro-max # Claude Code rm -rf .cursor/skills/ui-ux-pro-max # Cursor rm -rf .windsurf/skills/ui-ux-pro-max # Windsurf rm -rf .agents/skills/ui-ux-pro-max # Antigravity / Codex ``` ### Claude.ai's "Upload a skill" dialog says "Zip contains too many files (maximum 200)" Do not upload the full GitHub repository ZIP. It is a development checkout that includes source code, CLI assets, documentation, previews, and multiple bundled skills, so it exceeds Claude's 200-file upload limit. It is not a Claude skill upload artifact, and this project does not currently publish a separate manual-upload ZIP for Claude.ai. For Claude Code, install through the Marketplace: ```bash /plugin marketplace add nextlevelbuilder/ui-ux-pro-max-skill /plugin install ui-ux-pro-max@ui-ux-pro-max-skill ``` Or use the CLI installer: ```bash npx ui-ux-pro-max-cli init --ai claude ``` ### Claude Marketplace install fails with "Zip file contains a symbolic link" This is a known issue with versions prior to v2.5.1. The repository used symlinks internally which some installation tools can't handle. **Fix:** use the CLI installer instead: ```bash npm install ui-ux-pro-max-cli uipro init --ai claude ``` Or wait for the next release where this is resolved. ### `npm install ui-ux-pro-max-cli` fails with permission error Use a Node version manager (recommended), or skip the global install entirely: ```bash # npx without installing globally npx ui-ux-pro-max-cli init --ai claude ``` ### Python not found when running design system commands The search scripts require Python 3.x. Install it manually from [python.org](https://www.python.org/downloads/) or with your OS package manager (Homebrew, apt, winget). AI agents should not install it for you — they are instructed to ask you instead. ### Design system output is cut off / fields truncated Human-readable output truncates long fields at 300 characters. Use `--json` to get the full, untruncated data: ```bash python3 .claude/skills/ui-ux-pro-max/scripts/search.py "SaaS" --domain style --json ``` --- ## Star History [](https://star-history.dera.page/#nextlevelbuilder/ui-ux-pro-max-skill&Date) ## License This project is licensed under the [MIT License](LICENSE). ## Compatible Agents This skill works with: - [Claude Code](https://claude.com/product/claude-code) - [AdaL](https://sylph.ai/) - Self-evolving AI coding agent ([Docs](https://docs.sylph.ai/) | [GitHub](https://github.com/SylphAI-Inc/adal-cli)) --- ## File: cli/README.md # ui-ux-pro-max-cli CLI to install UI/UX Pro Max skill for AI coding assistants. ## Installation ```bash npm install ui-ux-pro-max-cli ``` ## Usage ```bash # Install for specific AI assistant uipro init --ai claude # Claude Code uipro init --ai cursor # Cursor uipro init --ai windsurf # Windsurf uipro init --ai antigravity # Antigravity uipro init --ai copilot # GitHub Copilot uipro init --ai kiro # Kiro uipro init --ai codex # Codex (Skills) uipro init --ai roocode # Roo Code uipro init --ai qoder # Qoder uipro init --ai gemini # Gemini CLI uipro init --ai trae # Trae uipro init --ai opencode # OpenCode uipro init --ai universal # Universal / Agent Standard (.agents/skills/) uipro init --ai all # All assistants # Options uipro init --offline # Compatibility flag; installs bundled templates uipro init --force # Overwrite existing files uipro init --global # Install globally to home directory (~/) # Other commands uipro versions # List available versions uipro update # Update the global CLI to the latest release uipro update --global # Refresh globally installed skill files from this CLI package ``` ## GitHub Authentication GitHub's unauthenticated API allows 60 requests/hour per IP. If you hit rate limits, you can provide a GitHub Personal Access Token (PAT) to raise the limit to 5,000 requests/hour. **Options (in order of precedence):** ```bash # 1. Pass directly as a flag (one-off use) uipro init --token ghp_yourtoken uipro versions --token ghp_yourtoken uipro update --token ghp_yourtoken # 2. Set as a project-scoped environment variable (recommended) export UI_PRO_MAX_GITHUB_TOKEN=ghp_yourtoken uipro init # 3. Fallback: GITHUB_TOKEN is also read if UI_PRO_MAX_GITHUB_TOKEN is not set export GITHUB_TOKEN=ghp_yourtoken uipro init ``` **Creating a token:** Go to , click **Generate new token (classic)**, and select **no scopes** — public repo access requires no permissions. Copy the token and store it as an environment secret; never hardcode it in source files. > **Warning:** `GITHUB_TOKEN` is automatically injected by GitHub Actions with broad repo permissions. Prefer `UI_PRO_MAX_GITHUB_TOKEN` in CI to avoid accidentally attaching workflow credentials to release download requests. ## How It Works `uipro init` generates assistant-specific files from the templates bundled with the installed CLI package. To get newer templates and data, update the package, then regenerate: ```bash uipro update # updates the global CLI to the latest release uipro init --ai codex --force # regenerate skill files from the new package ``` `uipro update` runs `npm install ui-ux-pro-max-cli@latest` for you (it shells out to `npm` only on Windows, where `npm` is a `.cmd`). You can still run that command manually if you prefer. When the CLI is already current, `uipro update` just refreshes the installed skill files. ## Development ```bash # Install dependencies bun install # Run locally bun run src/index.ts --help # Build bun run build # Sync bundled CLI assets from the source skill npm run sync:assets # Verify bundled assets are current before publishing npm run check:assets # Link for local testing bun link ``` ## License CC-BY-NC-4.0