XiaOldMan 7246805992
feat: add OpenClaw platform support (#527)
* feat: add OpenClaw platform support

Add OpenClaw as an install target so the skill can be installed with
`uipro init --ai openclaw` and removed via `uipro uninstall`.

OpenClaw discovers AgentSkills-format skills from `.agents/skills` in the
agent workspace and from `~/.agents/skills` (personal library on the default
state dir), so the platform config reuses the `.agents` layout already used
by the universal/codex targets with its own display name, detection entry,
and docs.

- new platform config src/ui-ux-pro-max/templates/platforms/openclaw.json
  (synced to cli/assets via sync:assets)
- register 'openclaw' in AIType, AI_TYPES, AI_FOLDERS, AI_TO_PLATFORM
- detect the shared .agents workspace directory and describe the platform
- keep the .agents-family suggestion on codex when all four .agents
  consumers are detected (length 2-3 -> 2-4)
- cover openclaw in the dry-run, template-script-paths, and
  agent-query-contract e2e specs
- document OpenClaw in README and cli/README

* chore: bump version to 2.15.0 in skill metadata files

Aligns skill.json, marketplace.json, and plugin.json with the latest
v2.15.0 release; main was still at 2.13.0. CLI package version stays on
its own npm release track.

* fix: cover OpenClaw in offline validator and detection regression

- bump scripts/validate-agent-guide.py PLATFORM_COUNT 21 -> 23 (main
  already had 22 configs with a stale count of 21; OpenClaw widens the
  gap to 23, so update the gate and keep it meaningful)
- add e2e regression: a sole .agents directory detects all four
  consumers (antigravity, codex, universal, openclaw) and still
  suggests codex rather than all
2026-10-12 18:08:03 +07:00

104 lines
3.4 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 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