@staff0rd/assist 0.490.3 → 0.491.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 +2 -1
- package/claude/commands/bug.md +7 -23
- package/claude/commands/draft.md +7 -23
- package/dist/commands/sessions/web/bundle.js +1 -1
- package/dist/index.js +662 -565
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -120,6 +120,7 @@ Every command supports `--help` for full detail on its flags and behaviour.
|
|
|
120
120
|
- `--refine` - Skip posting; walk through `synthesis.md` interactively and edit it in place
|
|
121
121
|
- `--apply` - Skip posting; walk through each finding asking apply/skip. Applied findings are fixed in the working tree
|
|
122
122
|
- `--backlog` - Skip posting; file all findings as a single bug backlog item with one phase per finding
|
|
123
|
+
- `--address-comments` - After the review posts comments and submits, start an Address Comments session (`assist review-pr-comments <n>`) for the PR. Only fires inside an assist session, and only when at least one comment was posted and the review was submitted
|
|
123
124
|
- `--verbose` - Per-line log output instead of the stacked-spinner UI (automatic in CI)
|
|
124
125
|
- `assist github commits <org> [--since <date>] [--top <n>] [--json]` - Report commit activity across a GitHub organisation: repos ranked by commits, top committers, and a per-repo author breakdown
|
|
125
126
|
- `assist news add [url]` - Add an RSS feed URL (rendered in the sessions web News tab)
|
|
@@ -134,7 +135,7 @@ Backlog item ids are written and displayed in an `a`-prefixed form (e.g. item 55
|
|
|
134
135
|
- `assist backlog list [--status <type>] [-a, --all] [--all-repos] [-v]` - List backlog items with status icons (alias: `ls`; also `assist list` / `assist ls`)
|
|
135
136
|
- `assist backlog add` - Add a new backlog item interactively (human CLI use only; agents must use `propose`)
|
|
136
137
|
- `assist backlog add --name <n> --type <t> --desc <d> --ac <criterion...>` - Add a backlog item from CLI options
|
|
137
|
-
- `assist backlog propose --json <file
|
|
138
|
+
- `assist backlog propose --json <file|-> [--confirmed]` - Create an agent-authored item from a JSON payload, previewed for approval in a web session. Outside a web session an agent invocation prints the draft and writes nothing until it is re-run with `--confirmed`; `--confirmed` is rejected in a web session, where the pane is the gate. Used by `/draft` and `/bug`. See [docs/backlog-item-preview.md](docs/backlog-item-preview.md)
|
|
138
139
|
- `assist backlog show <id> [--all-commits]` - Display full detail for a backlog item (alias: `view`). Activity lists the newest 10 commits; `--all-commits` prints every commit
|
|
139
140
|
- `assist backlog plan <id>` - Display the phased plan for a backlog item
|
|
140
141
|
- `assist backlog update-field <id> [--name <n>] [--desc <d>] [--type <t>] [--ac <criterion...>]` - Update fields on a backlog item
|
package/claude/commands/bug.md
CHANGED
|
@@ -21,18 +21,9 @@ Before asking the user about existing functionality — how a feature currently
|
|
|
21
21
|
|
|
22
22
|
Skip questions the user has already answered. Stop asking as soon as you have enough to write a clear bug report — don't over-interrogate.
|
|
23
23
|
|
|
24
|
-
## Step 3:
|
|
24
|
+
## Step 3: Compose the bug report
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
```
|
|
29
|
-
echo "${ASSIST_SESSION:-0}"
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
- **`1` (web session):** do NOT print the bug report in the terminal. Skip straight to Step 5 — `assist backlog propose` slides the item into the web UI preview pane, where the user approves it, rejects it, or leaves inline comments on specific lines. That pane is the review gate.
|
|
33
|
-
- **anything else:** show the user the bug report in chat as below, iterate (Step 4), then save.
|
|
34
|
-
|
|
35
|
-
Either way you compose the same content, so draft it before you call `propose`:
|
|
26
|
+
Compose the bug report's content, but do not show it to the user yet and do not work out where the review should happen — `propose` decides that in Step 4 and tells you what to do next.
|
|
36
27
|
|
|
37
28
|
**Name:** (concise title)
|
|
38
29
|
**Type:** bug
|
|
@@ -62,13 +53,7 @@ The description renders as markdown in both the terminal (`assist backlog show`)
|
|
|
62
53
|
**Actual:** what happens instead.
|
|
63
54
|
```
|
|
64
55
|
|
|
65
|
-
## Step 4:
|
|
66
|
-
|
|
67
|
-
In a web session, skip this step — the preview pane handles it.
|
|
68
|
-
|
|
69
|
-
Otherwise, ask the user if they want to change anything and iterate until they confirm.
|
|
70
|
-
|
|
71
|
-
## Step 5: Save
|
|
56
|
+
## Step 4: Propose the item
|
|
72
57
|
|
|
73
58
|
Propose the item and capture the id it prints. Use `propose`, not `assist backlog add` — `propose` is the reviewed path for an agent-authored item:
|
|
74
59
|
|
|
@@ -85,15 +70,14 @@ JSON
|
|
|
85
70
|
|
|
86
71
|
The payload is strict JSON — an unknown key is an error. `\n` inside the `description` string is a JSON escape and becomes a real newline, which is what the markdown rendering needs.
|
|
87
72
|
|
|
88
|
-
In a web session
|
|
73
|
+
Always run `propose` **as a background task**, and do no other work until it returns. In a web session it blocks on the preview pane until the user decides, which can take far longer than the default command timeout, and the pending preview dies with the process — a killed `propose` abandons the item.
|
|
89
74
|
|
|
90
|
-
|
|
75
|
+
`propose` decides where the bug report is reviewed and prints what to do next. Follow that instruction; never inspect the environment to work it out yourself:
|
|
91
76
|
|
|
92
|
-
- **
|
|
77
|
+
- **Created** — the item exists and its id is printed. Continue below.
|
|
78
|
+
- **Draft only** — it printed the rendered bug report, wrote nothing, and asked you to re-run with `--confirmed`. Show the rendered report in chat, ask the user if they want to change anything, and iterate until they confirm. Then re-run the same command with `--confirmed` appended to create the item.
|
|
93
79
|
- **Rejected** — the command exits non-zero and prints the reason plus every inline comment with the excerpt it was left on. Do not retry verbatim: address each comment, then call `propose` again with the revised payload. Repeat until it is approved.
|
|
94
80
|
|
|
95
|
-
Outside a web session the rendered item is printed and created straight away.
|
|
96
|
-
|
|
97
81
|
Note the created item id from the output — you'll pass it to the done signal below.
|
|
98
82
|
|
|
99
83
|
### Associate an external tracker
|
package/claude/commands/draft.md
CHANGED
|
@@ -22,18 +22,9 @@ Ask 2-4 targeted questions conversationally to flesh out the idea. Focus on:
|
|
|
22
22
|
|
|
23
23
|
Ask one question at a time. Wait for the user's response before asking the next.
|
|
24
24
|
|
|
25
|
-
## Step 3:
|
|
25
|
+
## Step 3: Compose the item
|
|
26
26
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
```
|
|
30
|
-
echo "${ASSIST_SESSION:-0}"
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
- **`1` (web session):** do NOT print the item in the terminal. Skip straight to Step 5 — `assist backlog propose` slides the whole item, plan included, into the web UI preview pane, where the user approves it, rejects it, or leaves inline comments on specific lines. That pane is the review gate.
|
|
34
|
-
- **anything else:** show the user the item in chat as below, iterate (Step 4), then save.
|
|
35
|
-
|
|
36
|
-
Either way you compose the same content, so draft it before you call `propose`:
|
|
27
|
+
Compose the item's content, but do not show it to the user yet and do not work out where the review should happen — `propose` decides that in Step 4 and tells you what to do next.
|
|
37
28
|
|
|
38
29
|
**Name:** (concise title)
|
|
39
30
|
**Type:** story or bug
|
|
@@ -90,13 +81,7 @@ Keep phases small (2-4 tasks each). A typical item should have 2-3 phases.
|
|
|
90
81
|
|
|
91
82
|
Most phases should NOT have manual checks. Only add `manualChecks` to a phase when the checks are genuinely difficult to automate (e.g. visual appearance, UX flow, hardware interaction). Do not add a final phase just for end-to-end verification — a review phase is auto-appended at runtime.
|
|
92
83
|
|
|
93
|
-
## Step 4:
|
|
94
|
-
|
|
95
|
-
In a web session, skip this step — the preview pane handles it.
|
|
96
|
-
|
|
97
|
-
Otherwise, ask the user if they want to change anything. Iterate until they confirm.
|
|
98
|
-
|
|
99
|
-
## Step 5: Save
|
|
84
|
+
## Step 4: Propose the item
|
|
100
85
|
|
|
101
86
|
Propose the item and capture the id it prints. Use `propose`, not `assist backlog add` plus `add-phase` — `propose` is the reviewed path for an agent-authored item, and it writes the item and every phase on a single approval:
|
|
102
87
|
|
|
@@ -117,15 +102,14 @@ JSON
|
|
|
117
102
|
|
|
118
103
|
The payload is strict JSON — an unknown key is an error. `\n` inside the `description` string is a JSON escape and becomes a real newline, which is what the markdown rendering needs. Each phase needs at least one task; omit `manualChecks` for the phases that don't need any (most of them).
|
|
119
104
|
|
|
120
|
-
In a web session
|
|
105
|
+
Always run `propose` **as a background task**, and do no other work until it returns. In a web session it blocks on the preview pane until the user decides, which can take far longer than the default command timeout, and the pending preview dies with the process — a killed `propose` abandons the item.
|
|
121
106
|
|
|
122
|
-
|
|
107
|
+
`propose` decides where the item is reviewed and prints what to do next. Follow that instruction; never inspect the environment to work it out yourself:
|
|
123
108
|
|
|
124
|
-
- **
|
|
109
|
+
- **Created** — the item and all of its phases exist and the id is printed. Continue below.
|
|
110
|
+
- **Draft only** — it printed the rendered item, wrote nothing, and asked you to re-run with `--confirmed`. Show the rendered item in chat, ask the user if they want to change anything, and iterate until they confirm. Then re-run the same command with `--confirmed` appended to create the item and its phases.
|
|
125
111
|
- **Rejected** — the command exits non-zero and prints the reason plus every inline comment with the excerpt it was left on. Do not retry verbatim: address each comment — including ones about the plan — then call `propose` again with the revised payload. Repeat until it is approved.
|
|
126
112
|
|
|
127
|
-
Outside a web session the rendered item is printed and created straight away.
|
|
128
|
-
|
|
129
113
|
Note the created item id from the output — you'll pass it to the done signal below.
|
|
130
114
|
|
|
131
115
|
### Associate an external tracker
|