@upgraide/ui-notes-cli 0.2.3 → 0.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@upgraide/ui-notes-cli",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "CLI for UI Notes - pull and manage UI feedback notes",
   "license": "MIT",
   "keywords": ["cli", "ui", "notes", "feedback", "ui-notes"],
@@ -13,7 +13,7 @@
     "formatters/*.ts",
     "resolvers/*.ts",
     "schemas/*.json",
-    "skills/*.md"
+    "skills/**/*.md"
   ],
   "engines": {
     "bun": ">=1.0.0"

package/skills/ui-notes/SKILL.md

@@ -0,0 +1,160 @@
+---
+name: ui-notes
+description: CLI commands for managing UI feedback notes — pull context, resolve issues, add comments, generate changelogs, and batch triage.
+---
+
+# UI Notes CLI
+
+`uinotes` is the CLI for UI Notes. Use these commands to triage, resolve, and manage UI feedback notes from your terminal.
+
+## Configuration
+
+```bash
+uinotes config                          # Show current config
+uinotes config set apiUrl <url>         # Set API URL
+uinotes config set apiKey <key>         # Set API key
+uinotes set project <slug>              # Bind project to current directory
+```
+
+## Context
+
+Fetch an AI-optimized digest of open UI notes.
+
+### When to use
+- At the start of a task to understand what UI issues exist
+- Before making UI changes to check for related notes
+- When the user asks about UI bugs, feedback, or design issues
+
+```bash
+uinotes context --format markdown
+```
+
+Add `--resolve-files --root-dir .` to map notes to source files.
+Add `--type bug` to filter by type (bug, ux, feature, question).
+Add `--project <slug>` to target a specific project.
+
+## Explain
+
+Get full context for a single note including comments, history, and visual diffs.
+
+### When to use
+- When investigating a specific note before fixing it
+- When you need comments, history, or visual diff context
+- When triaging a single note
+
+```bash
+uinotes explain <note-id>
+uinotes explain <note-id> --format json
+```
+
+Returns: note body, type, status, component, selector, URL, screenshot URL, all comments, status history, and visual diffs.
+
+## Resolve
+
+Mark notes as resolved after fixing the issue they describe.
+
+### When to use
+- After fixing a bug, UX issue, or implementing a feature request described in a note
+- After verifying a fix addresses the feedback
+
+```bash
+# Resolve with a message explaining the fix
+uinotes resolve <note-id> "Fixed by updating the component"
+
+# Mark as won't fix with explanation
+uinotes wontfix <note-id> "Working as intended"
+
+# Bulk resolve all notes for a component
+uinotes resolve-by-component <ComponentName> --message "Refactored component"
+```
+
+Always include a resolution message describing what was done.
+
+## Comment
+
+Add comments to notes to document progress or communicate.
+
+### When to use
+- To document what was tried or what's blocking a fix
+- To ask clarifying questions about a note
+- To provide a status update before resolving
+
+```bash
+uinotes comment <note-id> "Comment text here"
+uinotes comments <note-id>  # List existing comments
+```
+
+## Changelog
+
+Generate a changelog from notes resolved since a git ref or date.
+
+### When to use
+- After resolving notes, to generate a summary for PR descriptions
+- For release notes listing UI fixes
+- To audit what was fixed in a time period
+
+```bash
+uinotes changelog --since HEAD~5
+uinotes changelog --since v1.2.0 --format conventional
+uinotes changelog --since 2026-02-01 --format json
+```
+
+Formats: `markdown` (default), `conventional` (conventional commits), `json`.
+
+## Batch
+
+Execute multiple operations (resolve, wontfix, comment, reopen) in one invocation.
+
+### When to use
+- After triaging multiple notes and deciding actions for each
+- When resolving several notes as part of a single fix
+- For bulk operations that span multiple notes
+
+```bash
+echo '{"op":"resolve","id":"abc123","message":"Fixed overflow"}
+{"op":"comment","id":"def456","text":"Needs design input"}
+{"op":"wontfix","id":"ghi789","message":"Deprecated component"}' | uinotes batch -
+```
+
+Operations: `resolve`, `wontfix`, `comment` (requires `text`), `reopen`.
+Add `--dry-run` to preview without executing.
+
+## Pull
+
+Fetch raw note data from the API.
+
+```bash
+uinotes pull
+uinotes pull --project my-app --status open --type bug --limit 50
+```
+
+| Option | Description |
+|--------|-------------|
+| `--project <name>` | Filter by project |
+| `--status <status>` | Filter by status (`open`, `resolved`, `wontfix`) |
+| `--type <type>` | Filter by type (`bug`, `ux`, `feature`, `question`) |
+| `--limit <n>` | Max number of results |
+| `--resolve-files` | Map notes to source files |
+
+## Projects
+
+Manage projects.
+
+```bash
+uinotes projects                              # List all projects
+uinotes projects create <slug> <name>         # Create a project
+uinotes projects get <slug>                   # Get project details
+uinotes projects rename <slug> <name>         # Rename a project
+uinotes projects add-url <slug> <pattern>     # Add URL pattern
+uinotes projects remove-url <slug> <pattern>  # Remove URL pattern
+uinotes projects delete <slug>                # Archive a project
+```
+
+## Visual Diff
+
+Capture and compare page screenshots.
+
+```bash
+uinotes visual-diff --url https://myapp.com --project my-app
+uinotes visual-diff --compare  # Compare against previous screenshots
+```