stanley 50d8a7de09
feat: add Amazon Q Developer platform support (#521)
* feat: add Amazon Q Developer platform support

Add Amazon Q Developer as an install target so the skill can be installed
with `uipro init --ai amazonq` and removed via `uipro uninstall`.

Amazon Q loads every Markdown file under .amazonq/rules/ (recursively) as
always-on chat context, so only the rendered rule file goes there
(.amazonq/rules/ui-ux-pro-max.md). Data, scripts and the bundled
sub-skills go to .amazonq/skills/ via dataPath, the same split copilot
uses, so their reference docs are not pulled into every chat.

- new platform config src/ui-ux-pro-max/templates/platforms/amazonq.json
  (synced to cli/assets via sync:assets)
- register 'amazonq' in AIType, AI_TYPES, AI_FOLDERS, AI_TO_PLATFORM
- detect .amazonq workspace directories and describe the platform
- cover amazonq in the dry-run and template-script-paths e2e specs
- document Amazon Q Developer in README and cli/README

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

* docs: note that Amazon Q only auto-loads the rule file

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-09 12:06:45 +07:00

3.3 KiB

ui-ux-pro-max-cli

CLI to install UI/UX Pro Max skill for AI coding assistants.

Installation

npm install -g ui-ux-pro-max-cli

Usage

# 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 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):

# 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:

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

# 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