@khanglvm/relay 0.10.2 → 0.10.3
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/docs/AGENT.md +8 -0
- package/package.json +1 -1
- package/skills/relay/SKILL.md +7 -0
- package/src/cli.js +6 -2
package/docs/AGENT.md
CHANGED
|
@@ -5,6 +5,14 @@ rich content blocks (markdown, charts, diagrams, tables, code, custom HTML),
|
|
|
5
5
|
then **wait for them to click Submit** and read the answers as JSON from stdout.
|
|
6
6
|
No "type 'done' in the terminal", no hand-rolled HTML+server.
|
|
7
7
|
|
|
8
|
+
**Use relay even in plan mode** — for any clarifying or decision question (Claude
|
|
9
|
+
Code / Codex), route it through a relay board, **not** the native
|
|
10
|
+
`AskUserQuestion` / ask-user tool: that tool is **not** a substitute, even though
|
|
11
|
+
plan-mode guidance suggests it. Do NOT ask in plain terminal text and do NOT
|
|
12
|
+
reach for the native ask tool for anything beyond one trivial yes/no — open a
|
|
13
|
+
board. Reserve the harness's `ExitPlanMode` strictly for the final plan-approval
|
|
14
|
+
gate (it's a mode transition, not a question).
|
|
15
|
+
|
|
8
16
|
**Tell the user** at the start of your intro text that they can hover chart
|
|
9
17
|
points, diagram nodes, table cells, and any element of a custom-HTML block to
|
|
10
18
|
leave comments, and select text in markdown blocks to annotate — their comments
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@khanglvm/relay",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.3",
|
|
4
4
|
"description": "Browser-based question boards with rich blocks (markdown, charts, mermaid, tables, code, diffs, video, sandboxed HTML), clickable local file-links, and element-level annotations for AI coding agents (Claude Code, Codex, …): ask users structured questions, present interactive visuals, collect inline comments, wait for submit, read answers as JSON.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ai-agents",
|
package/skills/relay/SKILL.md
CHANGED
|
@@ -31,8 +31,15 @@ Schema).** The essentials are below.
|
|
|
31
31
|
| "Show me the diff" / git diff / code changes / before-after | **rly** (`diff` block — run `git diff`, render it; never dump it in the terminal) |
|
|
32
32
|
| A demo, screen recording or walkthrough | **rly** (`video` block) |
|
|
33
33
|
| Point the user at a file to open (log, capture, report) | **rly** (a clickable local file-link in markdown) |
|
|
34
|
+
| Plan-mode clarifying question (Claude Code / Codex) | **rly** (not AskUserQuestion / the native ask tool) |
|
|
34
35
|
| Something you can decide yourself from context | neither — just decide |
|
|
35
36
|
|
|
37
|
+
This holds **in plan mode** too: route every clarifying or decision question
|
|
38
|
+
through relay — the native `AskUserQuestion` / ask-user tool is **not** a
|
|
39
|
+
substitute, even though plan-mode guidance suggests it. Reserve the harness's
|
|
40
|
+
`ExitPlanMode` strictly for the final plan-approval gate (it's a mode
|
|
41
|
+
transition, not a question).
|
|
42
|
+
|
|
36
43
|
Once the user has answered one board in a session, prefer boards for later
|
|
37
44
|
question rounds too — they've shown they engage with them. Batch related
|
|
38
45
|
questions into ONE board rather than opening several in a row.
|
package/src/cli.js
CHANGED
|
@@ -799,8 +799,12 @@ function stampSkillVersion() {
|
|
|
799
799
|
const SKILL_RULES = `## relay — ask & show in the browser, not the terminal
|
|
800
800
|
|
|
801
801
|
- Need the user's decisions, feedback, requirements, or approval (anything
|
|
802
|
-
beyond one trivial yes/no)? Do NOT ask in plain terminal text
|
|
803
|
-
|
|
802
|
+
beyond one trivial yes/no)? Do NOT ask in plain terminal text **and do NOT use
|
|
803
|
+
the native \`AskUserQuestion\` / ask-user tool** — for anything beyond one
|
|
804
|
+
trivial yes/no, open a relay board. Build a board spec and run:
|
|
805
|
+
\`rly ask --file spec.json --detach\`, then \`rly wait <boardId>\`. **This holds
|
|
806
|
+
in plan mode too** — route clarifying/decision questions through relay there as
|
|
807
|
+
well; reserve \`ExitPlanMode\` for the final plan-approval gate only.
|
|
804
808
|
- Presenting a plan, structure, architecture, data, or a prototype? Show a
|
|
805
809
|
relay board with mermaid/graphviz/chart/table/code/diff/video/image/html
|
|
806
810
|
blocks — never ASCII diagrams or walls of prose.
|