mirror of
https://github.com/nextlevelbuilder/ui-ux-pro-max-skill.git
synced 2026-11-19 00:30:30 +00:00
* feat: add AutoClaw compatibility - Add root SKILL.md following the open SKILL.md standard - Add 'autoclaw' to skill.json#platforms - Add AutoClaw install instructions to README - Add docs/autoclaw-install.md with detailed install guide AutoClaw is Z.ai's official general-purpose AI agent (https://autoclaw.z.ai), part of the GLM Coding Plan family alongside ZCode and OpenClaw. This PR adds first-class AutoClaw support without changing any existing platform install paths. Verified SKILL.md compliance with AutoClaw/ZCode spec: - name and description in frontmatter (required) - description < 1024 chars - body < 100KB - explicit trigger phrases in description * text feat(cli): add AutoClaw platform support - Register 'autoclaw' in AIType, AI_TYPES, and AI_FOLDERS configuration. - Update SKILL.md to fix broken search script paths and incorrect folder layout documentation. - Synchronize CLI assets to ensure platform configuration and script paths are correctly bundled. * fix(cli): install AutoClaw skills where AutoClaw actually loads them AutoClaw does not scan `.autoclaw`; it reads workspace `skills/` plus the shared `~/.openclaw-autoclaw/skills` directory. Point the platform config at those roots so `uipro init --ai autoclaw` produces a skill that AutoClaw discovers without extra configuration. - register `autoclaw` in AI_TO_PLATFORM and add templates/platforms/autoclaw.json with root `skills` and globalRoot `.openclaw-autoclaw/skills` - detect AutoClaw from `.autoclaw` or an installed `skills/ui-ux-pro-max/SKILL.md` and add its CLI description - sync cli/assets, including the packaged autoclaw.json - restore the `## Using the Search Script (CLI)` section in the canonical skill template, keep the explanatory paragraph as body text, and remove the source-repo path from generated content - make search.py add its own directory to sys.path so sibling imports work on embedded Python builds whose `._pth` omits the script directory (AutoClaw's bundled runtime) - remove the hand-maintained root SKILL.md; templates/base/skill-content.md is the single source of truth - rewrite docs/INSTALL.md around the verified local and global CLI workflows - update e2e coverage for the new platform count, detection, and script paths Validated with npm run check:assets, npm run typecheck, 49 Playwright tests, 164 Python tests, and local/global installs whose generated search script runs successfully from the installed skill directory. * Update search.py
105 lines
3.5 KiB
Markdown
105 lines
3.5 KiB
Markdown
# ui-ux-pro-max-cli
|
|
|
|
CLI to install UI/UX Pro Max skill for AI coding assistants.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install -g 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 amazonq # Amazon Q Developer
|
|
uipro init --ai openclaw # OpenClaw (.agents/skills/)
|
|
uipro init --ai autoclaw # AutoClaw (skills/ or ~/.openclaw-autoclaw/skills)
|
|
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 <https://github.com/settings/tokens>, 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 -g 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
|
|
|
|
MIT
|