getgloss 0.7.1 → 0.8.0
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.
- package/README.md +54 -18
- package/dist/cli/index.js +1009 -220
- package/dist/cli/index.js.map +1 -1
- package/dist/server/daemon.js +1126 -188
- package/dist/server/daemon.js.map +1 -1
- package/dist/web/assets/index-DBK7WjlV.css +1 -0
- package/dist/web/assets/index-DkylW082.js +244 -0
- package/dist/web/assets/syntax-DdLzhglo.js +13 -0
- package/dist/web/index.html +2 -2
- package/dist/web/prompt.md +14 -6
- package/dist/web/setup.md +24 -8
- package/package.json +4 -1
- package/skill/SKILL.md +32 -11
- package/dist/web/assets/index-BsRo7I09.css +0 -1
- package/dist/web/assets/index-ENS6WF0D.js +0 -179
package/README.md
CHANGED
|
@@ -9,6 +9,23 @@ git diff, opens a localhost review UI, lets you attach comments to changed
|
|
|
9
9
|
lines or ranges, and writes structured feedback under `~/.gloss` for an agent
|
|
10
10
|
to re-ingest.
|
|
11
11
|
|
|
12
|
+
## Demo
|
|
13
|
+
|
|
14
|
+
<video
|
|
15
|
+
src="public/gloss-demo.mp4"
|
|
16
|
+
poster="public/gloss-demo-poster.jpg"
|
|
17
|
+
controls
|
|
18
|
+
>
|
|
19
|
+
<track
|
|
20
|
+
default
|
|
21
|
+
kind="captions"
|
|
22
|
+
label="English"
|
|
23
|
+
src="public/gloss-demo-captions.vtt"
|
|
24
|
+
srclang="en"
|
|
25
|
+
/>
|
|
26
|
+
Watch the Gloss demo video in `public/gloss-demo.mp4`.
|
|
27
|
+
</video>
|
|
28
|
+
|
|
12
29
|
## Install
|
|
13
30
|
|
|
14
31
|
```bash
|
|
@@ -51,10 +68,11 @@ npx skills add iamrajjoshi/gloss --skill gloss -a claude-code
|
|
|
51
68
|
`-g` installs to `~/.claude/skills/`, `-a claude-code` targets Claude Code, and
|
|
52
69
|
`--skill gloss` installs only the Gloss skill folder from the repo. The skill
|
|
53
70
|
teaches agents to run `gloss open --json`, wait for browser submission, read
|
|
54
|
-
`feedbackPath`, apply comments, validate,
|
|
55
|
-
|
|
71
|
+
`feedbackPath`, apply comments, validate, continue the same review with
|
|
72
|
+
`gloss open --review <reviewId> --json`, and mark comments or turns resolved
|
|
73
|
+
with `gloss resolve`.
|
|
56
74
|
|
|
57
|
-
The hosted install script
|
|
75
|
+
The hosted install script installs the npm package:
|
|
58
76
|
|
|
59
77
|
```bash
|
|
60
78
|
curl -fsSL https://getgloss.dev/install.sh | sh
|
|
@@ -63,12 +81,12 @@ curl -fsSL https://getgloss.dev/install.sh | sh
|
|
|
63
81
|
## Commands
|
|
64
82
|
|
|
65
83
|
```text
|
|
66
|
-
gloss open [--base <ref>] [--print-url] [--no-open] [--json] [--no-watch] [--timeout <s>]
|
|
84
|
+
gloss open [--base <ref>] [--review <reviewId>] [--print-url] [--no-open] [--json] [--no-watch] [--timeout <s>]
|
|
67
85
|
gloss watch <reviewId>
|
|
68
|
-
gloss resolve <reviewId> [--comment <commentId>] [--summary <text>] [--json]
|
|
86
|
+
gloss resolve <reviewId> [--comment <commentId>] [--turn <id-or-index>] [--summary <text>] [--json]
|
|
69
87
|
gloss start [--port <port>]
|
|
70
88
|
gloss status
|
|
71
|
-
gloss stop
|
|
89
|
+
gloss stop [--all]
|
|
72
90
|
gloss doctor
|
|
73
91
|
```
|
|
74
92
|
|
|
@@ -83,6 +101,14 @@ best available merge-base from upstream, `origin/HEAD`, `origin/main`, or
|
|
|
83
101
|
Use `--base <ref>` when you want an explicit comparison. Explicit base mode
|
|
84
102
|
compares only against the requested ref and does not switch to a branch diff.
|
|
85
103
|
|
|
104
|
+
`gloss open --json` waits until the browser review is submitted. Use
|
|
105
|
+
`--no-watch` when a caller only needs to open the review and return immediately.
|
|
106
|
+
Use `gloss open --review <reviewId> --json` after applying feedback to capture
|
|
107
|
+
the next diff as another turn in the same browser review.
|
|
108
|
+
The background server exits automatically after a short idle window with no
|
|
109
|
+
pending reviews. `gloss doctor` reports unmanaged daemon processes, and
|
|
110
|
+
`gloss stop --all` cleans them up.
|
|
111
|
+
|
|
86
112
|
## Review UI
|
|
87
113
|
|
|
88
114
|
In the browser review, drag over a changed line or range to open a draft
|
|
@@ -90,6 +116,11 @@ comment. Use `Command+Enter` to save the active draft comment. Use
|
|
|
90
116
|
`Command+Shift+Enter` to submit the review; this matches the Submit button and
|
|
91
117
|
includes already-saved comments only.
|
|
92
118
|
|
|
119
|
+
When branch reviews include per-commit diffs, the commit picker changes only the
|
|
120
|
+
current preview. Gloss persists that selected scope when the review is submitted,
|
|
121
|
+
so `feedback.json` records whether the human reviewed all commits, one commit, or
|
|
122
|
+
a contiguous commit range.
|
|
123
|
+
|
|
93
124
|
## Feedback Files
|
|
94
125
|
|
|
95
126
|
Submitted reviews are written to:
|
|
@@ -97,21 +128,26 @@ Submitted reviews are written to:
|
|
|
97
128
|
```text
|
|
98
129
|
~/.gloss/reviews/<reviewId>/
|
|
99
130
|
meta.json
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
131
|
+
turns/
|
|
132
|
+
<turnId>/
|
|
133
|
+
turn.json
|
|
134
|
+
diff.json
|
|
135
|
+
feedback.json
|
|
136
|
+
feedback.md
|
|
137
|
+
resolved.json
|
|
104
138
|
```
|
|
105
139
|
|
|
106
|
-
`feedback.json` is the machine-readable payload
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
140
|
+
`feedback.json` is the machine-readable payload and includes `reviewScope` for
|
|
141
|
+
submitted commit-preview scope. `feedback.md` is a readable summary ordered by
|
|
142
|
+
file and line. `resolved.json` is mutable resolution progress for individual
|
|
143
|
+
comments and the turn. After applying feedback, use
|
|
144
|
+
`gloss resolve <reviewId> --comment <commentId> --summary "..."` for a single
|
|
145
|
+
comment or `gloss resolve <reviewId> --turn <id-or-index> --summary "..."` for a
|
|
146
|
+
specific turn. Without `--turn`, whole-review resolution targets the latest
|
|
147
|
+
turn. Set `GLOSS_STATE_DIR` to use an isolated state root for tests or
|
|
112
148
|
development.
|
|
113
|
-
For a follow-up pass after fixes or new commits,
|
|
114
|
-
`gloss open --json`.
|
|
149
|
+
For a follow-up pass after fixes or new commits, continue the same review with
|
|
150
|
+
`gloss open --review <reviewId> --json`.
|
|
115
151
|
|
|
116
152
|
## Development
|
|
117
153
|
|