review-workspace 1.0.0 → 1.0.1
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 +16 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,7 +6,22 @@ and `docs/spec.md` for the v1 spec.
|
|
|
6
6
|
|
|
7
7
|
## Reviewing an MR/PR
|
|
8
8
|
|
|
9
|
-
This repo (the engine: schema, validator, CLI, server, UI) never fetches a Comparison or writes a Review Document itself — that's the Generator's job, a separate Claude Code skill (see `skills/review-workspace/`).
|
|
9
|
+
This repo (the engine: schema, validator, CLI, server, UI) never fetches a Comparison or writes a Review Document itself — that's the Generator's job, a separate Claude Code skill (see `skills/review-workspace/`).
|
|
10
|
+
|
|
11
|
+
**Install the skill** (one-time, requires [Claude Code](https://claude.com/claude-code) — CLI, desktop app, or the claude.ai/code web app; a plain claude.ai chat can't run it, since it shells out to `glab`/`gh`/`npx`):
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
npx skills add sabasayer/review-workspace --global --agent claude-code -y
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
(Uses [vercel-labs/skills](https://github.com/vercel-labs/skills). Later, `npx skills update review-workspace` picks up any changes to the skill.)
|
|
18
|
+
|
|
19
|
+
Also requires:
|
|
20
|
+
|
|
21
|
+
- `glab` (GitLab) or `gh` (GitHub) CLI, installed and authenticated — that's what fetches the MR/PR diff.
|
|
22
|
+
- **Node ≥24** — `npx` itself ships with Node/npm, nothing extra to install, but an older Node on your `PATH` will fail to run the CLI. Check with `node --version`; if it's below 24, upgrade (e.g. via [nvm](https://github.com/nvm-sh/nvm): `nvm install 24 && nvm use 24`) before running `npx review-workspace`.
|
|
23
|
+
|
|
24
|
+
**Use it**: paste an MR/PR URL to Claude Code and ask it to review it, e.g. "Review this MR using the review-workspace skill: `<url>`". The skill scaffolds a bundle under `.bundles/`, generates + publishes the Review Document, then `serve`s it (see below) — no local clone of this repo needed, `npx` fetches the CLI/UI on demand.
|
|
10
25
|
|
|
11
26
|
To view an already-scaffolded bundle:
|
|
12
27
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "review-workspace",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "A local, offline decision surface for reviewing a code Comparison — evidence-linked map of intent, behavior, risk, and observable effects.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Salih Sayer",
|