@wji.ai/cli 0.4.0 → 0.5.1

package/skill/wji-classroom/SKILL.md

@@ -0,0 +1,161 @@
+---
+name: wji-classroom
+description: Run a class on WJI with the `wji` CLI — a teacher's workspace where every student has their own Infinite Canvas. Set up the class workspace, invite students by email or share link, create one private canvas per student, hand out preset prompts and starter nodes (copy the teacher's selected nodes into every student's canvas), then check each student's progress and collect their generated results by name, recency or color tag. Use when a teacher / instructor / 老師 / 講師 mentions a class, course, workshop, students / 學生 / 学员, assignments / homework / 作業, or wants to manage members' canvases on WJI.
+---
+
+# WJI classroom
+
+This skill sits on top of the `wji` skill — read that one for sign-in,
+models, generation and the canvas basics. Everything here is the `wji`
+CLI; the class-wide commands live under `wji class`.
+
+## How a class maps onto WJI
+
+| Class | WJI |
+| --- | --- |
+| the class | a workspace the teacher **owns** |
+| a student | a workspace member with role **editor** (viewers cannot generate) |
+| a student's desk | a canvas whose owner is that student, visibility `owner` — only they and the teacher see it |
+| handouts | workspace prompt presets, and starter nodes copied into every canvas |
+| an assignment | nodes carrying a color tag with a label, e.g. red = `HW1` |
+
+Only the workspace **owner** can invite, create share links and set canvas
+owners. Check first:
+
+```bash
+wji auth whoami
+wji ws member list <workspaceId>        # your row must say owner
+```
+
+## 1. Create the class workspace
+
+```bash
+wji ws create "Art 101 — Spring" -a canvas     # the canvas app is all a class needs
+wji ws use <workspaceId>                        # later commands default to it
+```
+
+## 2. Invite students
+
+```bash
+wji ws member invite amy@school.edu, ben@school.edu     # ≤50 per call; commas or spaces
+wji ws member link                                       # or a join link (valid 7 days) to post in the class chat
+wji ws member link --show                                # the active link
+wji class roster                                         # who has joined, role, canvas
+```
+
+- Registered emails join immediately (`added`); the others get an invitation
+  email and join after signing up (`invited`). Rerun `class roster` later.
+- There is **one** active link per workspace. `member link` — and any
+  `member invite` that emails someone — revokes the previous link. Tell the
+  teacher before replacing a link they already shared.
+- Late joiners via the link join as the link's role (default editor).
+- Wrong role: `wji ws member role "Ben" editor`. Remove: `wji ws member rm "Ben"`.
+
+## 3. One canvas per student
+
+```bash
+wji class canvases --create                    # named after each student, private
+wji class canvases --create --name "{name} · Art 101"
+wji class canvases --visibility members --update   # let the class see each other's canvases
+```
+
+It only creates what is missing, so rerun it after new students join. The
+teacher (workspace owner) sees every canvas; each student sees only theirs
+(plus any canvas with visibility `members`, e.g. a shared "Class board").
+Individual canvases: `wji canvas owner <canvasId> "Amy" --visibility owner`.
+
+## 4. Preset prompts, so students don't have to type
+
+Two ways, often both:
+
+**Workspace presets** — a prompt library for the class. Students press `/`
+on their canvas (the *workspace* tab) and the prompt becomes a text node, or
+`/` inside a generate node's prompt box to insert it.
+
+```bash
+wji preset create "Watercolor portrait" -w <workspaceId> -c utility -t hw1 \
+  -p "A soft watercolor portrait of @image1, loose brush strokes, paper texture"
+wji preset workspace                          # what the class sees
+```
+
+**Starter nodes** — a ready-to-run generate node (prompt, model, settings,
+reference images already wired) that students only have to press Generate on.
+Build it once on the teacher's canvas, then copy it to everyone (step 5):
+
+```bash
+wji canvas add image -c <teacherCanvas> -n "HW1 portrait" -m <model> \
+  -p "@image1 as a watercolor portrait" --from <referenceImageNode>
+```
+
+Pick the model with `wji models list --feature image` / `wji models get`.
+
+## 5. Copy nodes into every student's canvas
+
+The usual way: the teacher selects the nodes in the browser and presses the
+link button in the canvas top bar. Then:
+
+```bash
+wji canvas status                              # confirm what is selected
+wji canvas tag red --selected -l HW1           # optional: mark it as an assignment
+wji class copy -y                              # the selection → every student canvas
+wji class copy <nodeId> <nodeId> -c <canvasId> --student "Amy" "Ben" -y
+```
+
+- Connections between the copied nodes come along with their `@image1…`
+  order; finished images/videos are shared (not regenerated); generate nodes
+  keep prompt, model and settings but start un-generated.
+- The group lands to the right of what is already on each canvas (`--at x,y`
+  or `--same-position` to choose).
+- Color tags come along; the label (`HW1`) is added to a student's canvas if
+  that color has no label there yet.
+- Failures are reported per student with a `--student …` rerun hint.
+
+## 6. Check progress and gather results
+
+```bash
+wji class status                               # every student: nodes, done / running / failed / not run, gens, last gen, credits
+wji class status --tag HW1 --sort progress     # just the assignment, least done first
+wji class status --sort recent                 # who generated most recently
+wji class results --tag HW1                    # finished work, newest first
+wji class results --student "Amy" --since 2h
+wji class results --tag HW1 -d ./hw1           # download: ./hw1/<student>/<node>-<id>.png
+wji class results --tag HW1 --all              # also display nodes students uploaded
+```
+
+To review, download and look at the files, then leave feedback on the
+student's canvas:
+
+```bash
+wji canvas list --owner "Amy"
+wji canvas add comment -c <amyCanvas> -t "Lovely colors — try a warmer background" --at 0,-200
+```
+
+## Rules
+
+- **Emails go out in the teacher's name.** Show the exact address list and
+  role and get a yes in the chat before `ws member invite`. Same for
+  `ws member link` when a link is already active (it stops working).
+- **Copying writes into every student's canvas.** Say what will be copied
+  (node names, count of students) and get a yes, then pass `-y`.
+- **Don't generate on students' canvases** unless the teacher asks — it
+  spends the teacher's credits and replaces what the student would do. When
+  asked, follow the `wji` skill's cost rules (show the total for N students).
+- **Deleting in a student's canvas** (`canvas rm`) follows the `wji`
+  confirm-before-destroying rule, one canvas at a time.
+- Look students up by name or email (`--student "Amy"`); if a name is
+  ambiguous the CLI says so — ask, don't guess.
+
+## Good to know
+
+- Private (`owner`) visibility hides a canvas; it does not lock it. On a
+  `members` canvas any editor can edit anything.
+- Students can edit or delete workspace presets (the backend has no role
+  check there). Keep the canonical prompts in the teacher's own presets too
+  (`wji preset create` without `-w`) and re-copy with `wji preset copy`.
+- Generation history in a workspace is readable by every member, so students
+  can technically list each other's generations through the API even when
+  canvases are private.
+- Organization admins who are not the workspace owner cannot invite or set
+  canvas owners — the workspace owner must.
+- Credits in `class status` are what each student spent in this workspace
+  (all time); `wji ws quota` sets a workspace spending cap.