getgloss 0.1.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/LICENSE +22 -0
- package/README.md +109 -0
- package/dist/cli/index.js +638 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/mcp/index.js +293 -0
- package/dist/mcp/index.js.map +1 -0
- package/dist/server/daemon.js +427 -0
- package/dist/server/daemon.js.map +1 -0
- package/dist/web/assets/index-BiGi3rBS.css +1 -0
- package/dist/web/assets/index-GpOF1p41.js +149 -0
- package/dist/web/index.html +14 -0
- package/dist/web/prompt.md +58 -0
- package/dist/web/setup.md +133 -0
- package/package.json +80 -0
- package/skill/SKILL.md +23 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Raj Joshi
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
22
|
+
|
package/README.md
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# Gloss
|
|
2
|
+
|
|
3
|
+
Gloss is a local browser review loop for coding agents. It captures your current
|
|
4
|
+
git diff, opens a localhost review UI, lets you attach comments to changed
|
|
5
|
+
lines or ranges, and writes structured feedback back into the repo for an
|
|
6
|
+
agent to re-ingest.
|
|
7
|
+
|
|
8
|
+
## Install
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install -g getgloss
|
|
12
|
+
gloss open --base HEAD --json
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
For one-off use:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx getgloss open --base HEAD --json
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
For agent setup, use the Roughdraft-style prompt:
|
|
22
|
+
|
|
23
|
+
```text
|
|
24
|
+
Install Gloss for me using `npm i -g getgloss`, then read https://getgloss.dev/setup.md and set yourself up to use it.
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
The hosted install script is npm-only:
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
curl -fsSL https://getgloss.dev/install.sh | sh
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Commands
|
|
34
|
+
|
|
35
|
+
```text
|
|
36
|
+
gloss open [--base <ref>] [--print-url] [--no-open] [--json] [--no-watch] [--timeout <s>]
|
|
37
|
+
gloss watch <reviewId>
|
|
38
|
+
gloss start [--port <port>]
|
|
39
|
+
gloss status
|
|
40
|
+
gloss stop
|
|
41
|
+
gloss mcp
|
|
42
|
+
gloss doctor
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
`gloss open` lazy-starts a background server, captures tracked and untracked
|
|
46
|
+
changes against the base ref, registers a review session, opens
|
|
47
|
+
`http://localhost:<port>/review/<reviewId>`, and waits for submission unless
|
|
48
|
+
`--no-watch` is passed.
|
|
49
|
+
|
|
50
|
+
## Feedback Files
|
|
51
|
+
|
|
52
|
+
Completed reviews are written to:
|
|
53
|
+
|
|
54
|
+
```text
|
|
55
|
+
<repo>/.gloss/reviews/<reviewId>/
|
|
56
|
+
meta.json
|
|
57
|
+
diff.json
|
|
58
|
+
feedback.json
|
|
59
|
+
feedback.md
|
|
60
|
+
original/
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
`feedback.json` is the agent-friendly source of truth. `feedback.md` is a
|
|
64
|
+
human-readable summary ordered by file and line.
|
|
65
|
+
|
|
66
|
+
## MCP
|
|
67
|
+
|
|
68
|
+
`gloss mcp` starts a stdio MCP server exposing:
|
|
69
|
+
|
|
70
|
+
- `list_pending_reviews`
|
|
71
|
+
- `get_review`
|
|
72
|
+
- `watch_review`
|
|
73
|
+
- `get_review_feedback`
|
|
74
|
+
- `mark_review_resolved`
|
|
75
|
+
|
|
76
|
+
The MCP process talks to the same localhost server as the CLI.
|
|
77
|
+
|
|
78
|
+
## Development
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
pnpm dev:web
|
|
82
|
+
pnpm build
|
|
83
|
+
pnpm test
|
|
84
|
+
pnpm check
|
|
85
|
+
pnpm setup
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
`pnpm setup` creates a per-worktree wrapper in `~/.local/bin` named
|
|
89
|
+
`gloss-dev-<worktree>`, using an isolated state dir under `~/.gloss/dev/`.
|
|
90
|
+
|
|
91
|
+
## Release Flow
|
|
92
|
+
|
|
93
|
+
Releases follow Willow's tag-driven shape:
|
|
94
|
+
|
|
95
|
+
1. Push a tag like `v0.1.0`.
|
|
96
|
+
2. GitHub Actions runs checks, tests, and the production build.
|
|
97
|
+
3. The package is published to npm as `getgloss`.
|
|
98
|
+
4. A GitHub release is created with `npm pack` output and checksums.
|
|
99
|
+
|
|
100
|
+
Required repository secrets:
|
|
101
|
+
|
|
102
|
+
- `NPM_TOKEN`
|
|
103
|
+
|
|
104
|
+
## Notes
|
|
105
|
+
|
|
106
|
+
Gloss uses `@pierre/diffs` for diff parsing/rendering integration points and
|
|
107
|
+
skins the browser chrome for the local review workflow. The package is
|
|
108
|
+
Apache-2.0 licensed, which is compatible with this MIT project but worth
|
|
109
|
+
calling out before publication.
|