@upgraide/ui-notes-cli 0.2.5 → 0.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +111 -37
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -31,44 +31,32 @@ uinotes resolve 42 "Fixed in latest deploy"
31
31
  View or update configuration.
32
32
 
33
33
  ```bash
34
- # Show current config
35
- uinotes config
36
-
37
- # Set a value
34
+ uinotes config # Show current config
38
35
  uinotes config set apiUrl https://my-api.example.com
36
+ uinotes config set apiKey <your-key>
37
+ ```
38
+
39
+ ### `uinotes set project`
40
+
41
+ Bind a project to the current directory (creates `.uinotes` file).
39
42
 
40
- # Bind a project to the current directory
43
+ ```bash
41
44
  uinotes set project my-app
42
45
  ```
43
46
 
44
- **Config keys:** `apiUrl`, `apiKey`
45
-
46
47
  ### `uinotes projects`
47
48
 
48
49
  Manage projects.
49
50
 
50
51
  ```bash
51
- # List all projects
52
- uinotes projects
53
-
54
- # Include archived projects
55
- uinotes projects --archived
56
-
57
- # Create a project with URL patterns
58
- uinotes projects create my-app "My Application" --url "https://myapp.com/*"
59
-
60
- # Get project details
52
+ uinotes projects # List all projects
53
+ uinotes projects --archived # Include archived
54
+ uinotes projects create my-app "My App" --url "https://myapp.com/*"
61
55
  uinotes projects get my-app
62
-
63
- # Rename a project
64
56
  uinotes projects rename my-app "New Name"
65
-
66
- # Add/remove URL patterns
67
57
  uinotes projects add-url my-app "https://staging.myapp.com/*"
68
58
  uinotes projects remove-url my-app "https://old.myapp.com/*"
69
-
70
- # Archive a project
71
- uinotes projects delete my-app
59
+ uinotes projects delete my-app # Archive
72
60
  ```
73
61
 
74
62
  ### `uinotes pull`
@@ -78,31 +66,117 @@ Fetch notes from the API.
78
66
  ```bash
79
67
  uinotes pull
80
68
  uinotes pull --project my-app --status open --type bug --limit 50
69
+ uinotes pull --resolve-files --root-dir . # Map notes to source files
81
70
  ```
82
71
 
83
- | Option | Description |
84
- |--------|-------------|
85
- | `--project <name>` | Filter by project (overrides default) |
86
- | `--status <status>` | Filter by status (`open`, `resolved`, `wontfix`) |
87
- | `--type <type>` | Filter by type (`bug`, `ux`, `feature`, `question`) |
88
- | `--limit <n>` | Max number of results |
72
+ ### `uinotes context`
73
+
74
+ AI-optimized digest of open notes.
75
+
76
+ ```bash
77
+ uinotes context --project my-app
78
+ uinotes context --format xml --component Header
79
+ uinotes context --resolve-files --root-dir .
80
+ ```
89
81
 
90
- ### `uinotes resolve`
82
+ ### `uinotes explain`
91
83
 
92
- Mark a note as resolved.
84
+ Full context for a single note (body, comments, history, visual diffs).
93
85
 
94
86
  ```bash
95
- uinotes resolve <id> [message]
96
- uinotes resolve 42 "Fixed in v2.1" --project my-app
87
+ uinotes explain <note-id>
88
+ uinotes explain <note-id> --format json
97
89
  ```
98
90
 
99
- ### `uinotes wontfix`
91
+ ### `uinotes resolve` / `uinotes wontfix`
100
92
 
101
- Mark a note as won't fix.
93
+ Mark a note as resolved or won't fix.
102
94
 
103
95
  ```bash
96
+ uinotes resolve <id> [message]
104
97
  uinotes wontfix <id> [message]
105
- uinotes wontfix 99 "Out of scope for this release"
98
+ ```
99
+
100
+ ### `uinotes comment` / `uinotes comments`
101
+
102
+ Add or list comments on a note.
103
+
104
+ ```bash
105
+ uinotes comment <id> "Comment text"
106
+ uinotes comments <id>
107
+ ```
108
+
109
+ ### `uinotes resolve-by-component` / `uinotes resolve-by-selector`
110
+
111
+ Bulk resolve notes matching a component or selector.
112
+
113
+ ```bash
114
+ uinotes resolve-by-component OldWidget "Replaced with NewWidget"
115
+ uinotes resolve-by-selector ".deprecated" "Removed" --dry-run
116
+ ```
117
+
118
+ ### `uinotes changelog`
119
+
120
+ Generate a changelog from resolved notes.
121
+
122
+ ```bash
123
+ uinotes changelog --since HEAD~5
124
+ uinotes changelog --since v1.2.0 --format conventional
125
+ ```
126
+
127
+ ### `uinotes visual-diff`
128
+
129
+ Capture and compare page screenshots.
130
+
131
+ ```bash
132
+ uinotes visual-diff --project my-app
133
+ uinotes visual-diff --compare --width 1440
134
+ ```
135
+
136
+ ### `uinotes batch`
137
+
138
+ Execute NDJSON batch operations.
139
+
140
+ ```bash
141
+ echo '{"op":"resolve","id":"abc","message":"Fixed"}' | uinotes batch -
142
+ uinotes batch ops.ndjson --dry-run --concurrency 10
143
+ ```
144
+
145
+ ### `uinotes schema`
146
+
147
+ List or print API resource schemas.
148
+
149
+ ```bash
150
+ uinotes schema
151
+ uinotes schema --resource notes
152
+ ```
153
+
154
+ ### `uinotes install-skills`
155
+
156
+ Install Claude Code skill files into `.claude/skills/`.
157
+
158
+ ```bash
159
+ uinotes install-skills
160
+ uinotes install-skills --dir /path/to/project/.claude/skills
161
+ uinotes install-skills --check
162
+ ```
163
+
164
+ ### `uinotes doctor`
165
+
166
+ Check CLI configuration, API connectivity, and version.
167
+
168
+ ```bash
169
+ uinotes doctor
170
+ ```
171
+
172
+ Checks: config file, API URL, API key, API reachability, project binding, skills installed, CLI version.
173
+
174
+ ### `uinotes update`
175
+
176
+ Check for and install CLI updates.
177
+
178
+ ```bash
179
+ uinotes update
106
180
  ```
107
181
 
108
182
  ## Configuration
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@upgraide/ui-notes-cli",
3
- "version": "0.2.5",
3
+ "version": "0.2.6",
4
4
  "description": "CLI for UI Notes - pull and manage UI feedback notes",
5
5
  "license": "MIT",
6
6
  "keywords": ["cli", "ui", "notes", "feedback", "ui-notes"],