rig-review 0.23.0 → 0.24.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 CHANGED
@@ -30,7 +30,7 @@ existing compilation/playback dependencies.
30
30
 
31
31
  ## Start
32
32
 
33
- Install it beside the agent that produced the output, then open that output folder:
33
+ Install beside the producing agent and open the output folder:
34
34
 
35
35
  ```sh
36
36
  npm i -D @rig-c/review
@@ -94,3 +94,4 @@ Development and releasing: [Contributing workflows](https://github.com/rig-c/rev
94
94
  - [Product design](docs/DESIGN.md)
95
95
  - [Animation inspection](docs/ANIMATION_INSPECTION.md)
96
96
  - [Installed-producer fixture](docs/LIVE_FIXTURE.md)
97
+ - [Agent skill](skills/rig-review/SKILL.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "rig-review",
3
- "version": "0.23.0",
3
+ "version": "0.24.0",
4
4
  "type": "module",
5
5
  "description": "Local human rig inspection and structured feedback export",
6
6
  "license": "MIT",
@@ -41,6 +41,7 @@
41
41
  "docs/DESIGN.md",
42
42
  "docs/ANIMATION_INSPECTION.md",
43
43
  "docs/LIVE_FIXTURE.md",
44
+ "skills",
44
45
  "README.md",
45
46
  "LICENSE"
46
47
  ],
@@ -0,0 +1,89 @@
1
+ ---
2
+ name: rig-review
3
+ description: Hand a rig build or rig-parts/rig-pose output to a person for local inspection and retrieve their structured feedback with rig-review (@rig-c/review). Validate the delivery package (rig-review check), start or reuse a loopback inspection workspace and print its capability URL (rig-review open), read back submitted verdicts, frame intervals, stage-comment crop PNGs and applied producer edits (rig-review feedback --format json|issue), export comparison or feedback frame strips headlessly (rig-review strip), or steer an opted-in open page (rig-review control). Not for compiling a rig (use rigc or rig-parts) or grading a rig without a person's submission.
4
+ license: MIT
5
+ compatibility: Requires Bun 1.3.0 or later on PATH. The canonical npm package is @rig-c/review (npm i -D @rig-c/review, or bun add -d @rig-c/review; rig-review is the convenience install name); the command it installs is rig-review, and @rig-c/play is installed as a dependency.
6
+ ---
7
+
8
+ # rig-review — human inspection handoff and feedback retrieval
9
+
10
+ Load this when a rig or animation is **ready for a person to inspect**, or when
11
+ the person has submitted a review and you need to **read back what they asked to
12
+ change**. The workspace's reader is a person in a browser; this file states what
13
+ an agent can actually drive from the CLI, what only the person does, and where
14
+ every rule lives.
15
+
16
+ ## What an agent drives vs. what the person drives
17
+
18
+ 1. **Validate and hand off (agent):**
19
+ ```sh
20
+ npx rig-review check /absolute/path/to/output
21
+ npx rig-review open /absolute/path/to/output [--reference /abs/video.mp4] [--compare /abs/other] [--animation <name>] [--config /abs/config.json [--parts <dir>] [--source <png> --full <dir> [--head <dir>]] [--keypoints <file>]] [--control]
22
+ ```
23
+ `check` verifies the delivery contract and source SHA-256 without starting a
24
+ server. `open` starts or reuses a loopback worker behind the managed front
25
+ (`127.0.0.1:4318`, or `--direct`), prints the writable `#cap=…` URL alone on
26
+ stdout for the person to open, and prints the exact matching
27
+ `rig-review feedback …` command on stderr — [Owner handoff](https://github.com/rig-c/review/blob/main/docs/WORKFLOWS.md#one-command-owner-handoff).
28
+ 2. **Inspect, rebuild in scratch and submit (person in the browser):**
29
+ `rig-review` never opens a browser itself. Only the person holding the
30
+ `#cap=…` tab can inspect panels, run `Apply · Rebuild` through the installed
31
+ producer (`rig-parts`, `rig-pose`) into scratch, drag **Comment · C** crops,
32
+ choose **approved** or **changes-requested** in **Write review**, and click
33
+ **Submit review** — [Feedback ownership](https://github.com/rig-c/review/blob/main/docs/WORKFLOWS.md#feedback-ownership).
34
+ 3. **Act on what comes back (agent):**
35
+ ```sh
36
+ npx rig-review feedback /absolute/path/to/output [...same flags as open...] [--format json|issue]
37
+ npx rig-review strip /absolute/path/to/output --reference-video /abs/video.mp4 --animation <name> (--frames FIRST:LAST | --all-feedback) [--json] [--out /abs/outside/strip.png]
38
+ ```
39
+ Read `status` (`pending` means the person has not submitted yet; opening
40
+ never approves), `reviewedSource` (rig/motion SHA-256 and tool versions),
41
+ `applied` (the exact config patches, pose-map/retarget flags and producer
42
+ lines the person applied in scratch), `feedback` (inclusive frame intervals,
43
+ bone/slot/rig targets, `defect`|`quality` category and summary), and
44
+ `comments` (pin/box coordinates, nearest drawn slots, and derived crop PNG
45
+ paths under `~/.local/state/rig-c-review/` that you can open directly without
46
+ a browser). Apply the requested fixes in the upstream producer (`rig-parts`,
47
+ `rig-pose` or `rigc`), rebuild, and run `rig-review open` again.
48
+ 4. **Optional live view steering (agent, only while the person's tab is open):**
49
+ When opened with `--control` and a browser tab is connected,
50
+ `npx rig-review control <dir> [...same flags...] [--page <id> --expected-revision <n> --request-id <id> --command <JSON>]`
51
+ reads or steers camera, time, animation and layers; it cannot submit or
52
+ approve a review or mutate source files — [Control](https://github.com/rig-c/review/blob/main/docs/WORKFLOWS.md#control-the-current-inspection-page).
53
+
54
+ ## Non-negotiables
55
+
56
+ - **Supplied packages and models stay immutable.** Review never edits
57
+ `motion.json`, `skeleton.model.json` or source art; producer edits run in
58
+ scratch and feedback is stored under `~/.local/state/rig-c-review/` (or
59
+ `RIG_REVIEW_STATE_DIR` outside every input package) bound to the exact content
60
+ SHA-256 — [REVIEW_PACKAGE.md](https://github.com/rig-c/review/blob/main/docs/REVIEW_PACKAGE.md).
61
+ - **Pass the exact handoff flags to `feedback` and `control`.** `--reference`,
62
+ `--compare`, `--animation` and `--config` (`--parts`, `--source`, `--full`,
63
+ `--head`, `--keypoints`) are hashed into the session identity; omitting one
64
+ reads a different session, and changing any input byte starts a fresh
65
+ `pending` session — [WORKFLOWS.md](https://github.com/rig-c/review/blob/main/docs/WORKFLOWS.md#one-command-owner-handoff).
66
+ - **Never leak the `#cap=` fragment into public logs or commits.** The fragment
67
+ is the per-instance 256-bit write capability; share it only with the person
68
+ reviewing on the local machine — [Managed front](https://github.com/rig-c/review/blob/main/docs/WORKFLOWS.md#managed-front-and-write-capability).
69
+ - **Strip outputs go outside every input package.** `rig-review strip --out`
70
+ refuses a path inside any reviewed package and requires `frameTimes` in the
71
+ report plus `ffmpeg` (≥ 5.1) and `ffprobe` on `PATH` for PNG video decoding —
72
+ [Frame strip export](https://github.com/rig-c/review/blob/main/docs/WORKFLOWS.md#frame-strip-export).
73
+
74
+ ## Read, in this order
75
+
76
+ 1. [docs/WORKFLOWS.md](https://github.com/rig-c/review/blob/main/docs/WORKFLOWS.md) —
77
+ `open`, `check`, `compare`, `feedback` (`--format json|issue`), `strip`,
78
+ `control`, the launcher stdout/stderr/exit-code contract and `OPEN_*` /
79
+ `FRONT_*` refusal codes.
80
+ 2. [docs/REVIEW_PACKAGE.md](https://github.com/rig-c/review/blob/main/docs/REVIEW_PACKAGE.md) —
81
+ folder discovery (`skeleton.model.json`, `build/skeleton.model.json`, and
82
+ `rig-parts build` roots), `review.json`, producer handoff (`HANDOFF_*`),
83
+ session/feedback schema and historical retrieval.
84
+ 3. [docs/PANELS.md](https://github.com/rig-c/review/blob/main/docs/PANELS.md) and
85
+ [docs/ANIMATION_INSPECTION.md](https://github.com/rig-c/review/blob/main/docs/ANIMATION_INSPECTION.md) —
86
+ what each browser panel writes into `applied`, `feedback` and `comments`.
87
+
88
+ Every guide linked above ships in the installed package under
89
+ `node_modules/@rig-c/review/docs/`, matching the installed version.