pipeup 0.8.1 → 0.8.2
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 -2
- package/cli/init.mjs +3 -3
- package/cli/pipeup.mjs +127 -22
- package/cli/read.mjs +1 -1
- package/dist/addons.json +1 -1
- package/dist/pipeup.agents.js +2 -2
- package/dist/pipeup.core.js +1 -1
- package/dist/pipeup.esm.js +1 -1
- package/dist/pipeup.min.js +1 -1
- package/dist/types/core.d.ts +2 -2
- package/package.json +1 -1
- package/skills/pipeup-add/SKILL.md +2 -2
- package/skills/pipeup-apply/SKILL.md +17 -7
- package/skills/pipeup-integrate/SKILL.md +11 -10
- package/skills/pipeup-send-to-git-setup/SKILL.md +1 -1
- package/skills/pipeup-summarise/SKILL.md +1 -1
package/dist/types/core.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export declare const VERSION = "0.8.
|
|
1
|
+
export declare const VERSION = "0.8.2";
|
|
2
2
|
/** The day this version was made (set with the version): Pipeup says so, once, in the console when it is over a year old. */
|
|
3
|
-
export declare const BUILT = "2026-10-
|
|
3
|
+
export declare const BUILT = "2026-10-19";
|
|
4
4
|
export { PipeupDocument, UnsavedChangeError, type Listener, type OpenOptions } from "./document";
|
|
5
5
|
export { DEFAULT_PROFILE_NAME, MemoryStore, loadOrCreateProfile, type OpStore, type Profile, } from "./storage/store";
|
|
6
6
|
export { IndexedDbStore } from "./storage/indexeddb";
|
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@ description: Use when someone asks you to add comments to an HTML page, make it
|
|
|
5
5
|
|
|
6
6
|
# Add Pipeup to this page
|
|
7
7
|
|
|
8
|
-
Written for Pipeup 0.8.
|
|
8
|
+
Written for Pipeup 0.8.2 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-add/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md) (the full reference: layouts, decks, tabs, every option), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md) (answering the comments) and [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md).
|
|
9
9
|
|
|
10
10
|
Pipeup lets people comment on an HTML page in place. **When the page already exists, never change its layout, styling or behaviour to make room for Pipeup**: it draws in its own layer, and you only add attributes and one script tag. Edit the HTML file only; don't download, fetch or run anything yourself.
|
|
11
11
|
|
|
@@ -14,7 +14,7 @@ Pipeup lets people comment on an HTML page in place. **When the page already exi
|
|
|
14
14
|
1. **Pin the script.** Just before `</body>`:
|
|
15
15
|
|
|
16
16
|
```html
|
|
17
|
-
<script src="https://cdn.jsdelivr.net/npm/pipeup@0.8.
|
|
17
|
+
<script src="https://cdn.jsdelivr.net/npm/pipeup@0.8.2/dist/pipeup.min.js"
|
|
18
18
|
integrity="sha384-…" crossorigin="anonymous"></script>
|
|
19
19
|
```
|
|
20
20
|
|
|
@@ -5,14 +5,14 @@ description: Use when someone asks you to act on Pipeup feedback for an HTML pag
|
|
|
5
5
|
|
|
6
6
|
# Apply Pipeup feedback
|
|
7
7
|
|
|
8
|
-
Written for Pipeup 0.8.
|
|
8
|
+
Written for Pipeup 0.8.2 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md), [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md).
|
|
9
9
|
|
|
10
10
|
## 1. Read the comments
|
|
11
11
|
|
|
12
12
|
Use the first of these that works:
|
|
13
13
|
|
|
14
|
-
0. **A live link** (the author runs `npx pipeup watch report.html --agent Claude` on this computer, opens the page it
|
|
15
|
-
prints, and switches on **Share with my agent**): run `npx pipeup comments report.html` (add `--all` for resolved
|
|
14
|
+
0. **A live link** (the author runs `npx --yes pipeup@0 watch report.html --agent Claude` on this computer, opens the page it
|
|
15
|
+
prints, and switches on **Share with my agent**): run `npx --yes pipeup@0 comments report.html` (add `--all` for resolved
|
|
16
16
|
threads, `--json` for data). No browser needed. If it says nothing is shared, ask the author to switch the switch on.
|
|
17
17
|
Your replies below reach the open page within seconds. The link lists your key for the page while it runs.
|
|
18
18
|
1. **Run the page** in a browser (you can drive one, or the author has it open) and evaluate
|
|
@@ -42,21 +42,31 @@ Answer a question with an answer, not a change.
|
|
|
42
42
|
You answer in the page's **replies file**, next to the page (`report.html` → `report.replies.js`), signed with your
|
|
43
43
|
own key. The key stays on this computer in `~/.pipeup/agent.json`; never put it in the page or its folder.
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
Run these commands exactly as written: `--yes` stops npx asking "Ok to proceed?", and `pipeup@0` takes any release npm
|
|
46
|
+
will give (some computers only accept packages a few days old). Every release from 0.6 answers them the same way. A
|
|
47
|
+
pre-release page's prompt names its pre-release; if npm refuses that one, use `pipeup@0`.
|
|
48
|
+
|
|
49
|
+
`--page` is **the HTML file that runs Pipeup**, the one the author opened, never a file it shows: on a viewer such as
|
|
50
|
+
`wiki/viewer.html?file=notes.md`, pass `wiki/viewer.html`. The prompt the author copies names it. If you can't tell,
|
|
51
|
+
ask; if the command says the file doesn't run Pipeup, it names the page to use instead.
|
|
52
|
+
|
|
53
|
+
First time only — ask the author whether you may list yourself on the page. After their yes, this makes your key (once)
|
|
54
|
+
and lists it; without `--yes` it only shows the change. The author also needs the **agents add-on**
|
|
46
55
|
(`@pipeup/agents`), which is what shows your replies in the page (neither is needed under a live link, which lists your
|
|
47
56
|
key and adds the add-on for you):
|
|
48
57
|
|
|
49
58
|
```bash
|
|
50
|
-
npx pipeup agent --name Claude
|
|
51
|
-
# prints: <html data-pipeup-agents="<your public key>"> (the author adds this to the page's <html> tag)
|
|
59
|
+
npx --yes pipeup@0 agent --name Claude --page report.html --yes
|
|
52
60
|
```
|
|
53
61
|
|
|
54
62
|
Then, for each thread:
|
|
55
63
|
|
|
56
64
|
```bash
|
|
57
|
-
npx pipeup reply --page report.html --thread <Thread id> "Changed the 20% to 15 to 20%, in the second paragraph." --addressed "addressed in revision 2"
|
|
65
|
+
npx --yes pipeup@0 reply --page report.html --thread <Thread id> "Changed the 20% to 15 to 20%, in the second paragraph." --addressed "addressed in revision 2"
|
|
58
66
|
```
|
|
59
67
|
|
|
68
|
+
It says where it wrote the replies, and, if the page doesn't list you yet, that the page will ignore them until it does.
|
|
69
|
+
|
|
60
70
|
- The words say plainly what changed and where. If you did not make the change, say why, and leave out `--addressed`.
|
|
61
71
|
- `--addressed` marks the thread addressed: the author sees your note and chooses **Resolve** or **Still not right**.
|
|
62
72
|
- Your replies show under your own name (for example "Claude" or "Codex") with the AI marking. The page ignores replies from a key it doesn't list,
|
|
@@ -5,7 +5,7 @@ description: Use when creating or editing an HTML document, slide deck, report,
|
|
|
5
5
|
|
|
6
6
|
# Add Pipeup to a page: the full reference
|
|
7
7
|
|
|
8
|
-
Written for Pipeup 0.8.
|
|
8
|
+
Written for Pipeup 0.8.2 For a quick "add comments to this page", [pipeup-add](https://pipeup-ai.github.io/pipeup/skills/pipeup-add/SKILL.md) is the short version; this is the full reference. This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md. Its companions: [summarise](https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md).
|
|
9
9
|
|
|
10
10
|
Pipeup lets people comment on an HTML page in place: select text, click any element (including
|
|
11
11
|
buttons and charts) or drop a pin on a slide. Your job is to make the page *reviewable* while it
|
|
@@ -75,7 +75,7 @@ Then choose the options (see "Options" below): usually just the defaults.
|
|
|
75
75
|
- Just before `</body>`, add the script pinned to an exact version:
|
|
76
76
|
|
|
77
77
|
```html
|
|
78
|
-
<script src="https://cdn.jsdelivr.net/npm/pipeup@0.8.
|
|
78
|
+
<script src="https://cdn.jsdelivr.net/npm/pipeup@0.8.2/dist/pipeup.min.js"
|
|
79
79
|
integrity="sha384-…" crossorigin="anonymous"></script>
|
|
80
80
|
```
|
|
81
81
|
|
|
@@ -140,7 +140,7 @@ Then choose the options (see "Options" below): usually just the defaults.
|
|
|
140
140
|
never a revision, version or date: those change for every comment already made, which then counts as
|
|
141
141
|
somewhere else.
|
|
142
142
|
|
|
143
|
-
8. **Check, and fix until it passes:** once it ships, run `npx pipeup check page.html`; until then, open the page and check the items below by eye. Fix every `fail`; fix
|
|
143
|
+
8. **Check, and fix until it passes:** once it ships, run `npx --yes pipeup@0 check page.html`; until then, open the page and check the items below by eye. Fix every `fail`; fix
|
|
144
144
|
`warn` items unless the author says otherwise. Typical fixes:
|
|
145
145
|
- *layout changed* — you edited styles or wrappers; undo that.
|
|
146
146
|
- *closed UI overlaps content* — add `data-pipeup-ignore` to a floating element that shouldn't be covered, or set
|
|
@@ -159,7 +159,7 @@ Then choose the options (see "Options" below): usually just the defaults.
|
|
|
159
159
|
- Don't wrap content in new elements or add classes for Pipeup.
|
|
160
160
|
- Don't add inline styles, z-index changes or padding "for the comment column".
|
|
161
161
|
- Don't load the script from anywhere but the pinned CDN URL
|
|
162
|
-
(`https://cdn.jsdelivr.net/npm/pipeup@0.8.
|
|
162
|
+
(`https://cdn.jsdelivr.net/npm/pipeup@0.8.2/dist/pipeup.min.js`, with the `integrity` value from
|
|
163
163
|
the release notes) or a copy of that same file next to the page. Never use an unpinned URL.
|
|
164
164
|
- Don't put secrets in `data-pipeup-doc`; it *is* the document's key — anyone with the file can
|
|
165
165
|
read its feedback, which is the intended audience.
|
|
@@ -177,7 +177,7 @@ page opened from disk and in any script order, and they are released with Pipeup
|
|
|
177
177
|
|
|
178
178
|
- **Ask first, and say in plain words what it sends and to whom** (the line above, and the add-on's README). Never
|
|
179
179
|
pick a sharing service yourself: the author chooses one.
|
|
180
|
-
- Add it as one more `<script>` after Pipeup's, pinned the same way (`https://cdn.jsdelivr.net/npm/@pipeup/share@0.8.
|
|
180
|
+
- Add it as one more `<script>` after Pipeup's, pinned the same way (`https://cdn.jsdelivr.net/npm/@pipeup/share@0.8.2/dist/share.min.js`
|
|
181
181
|
with its `integrity` from the release notes), or use the combined file `pipeup+share.min.js` instead of Pipeup's.
|
|
182
182
|
- Sharing is set up by the author with the command line (`npx @pipeup/share create page.html --server …`), which writes
|
|
183
183
|
`data-pipeup-share` into the file and prints a stop key once. **Never write `data-pipeup-share` yourself and never
|
|
@@ -197,9 +197,10 @@ page opened from disk and in any script order, and they are released with Pipeup
|
|
|
197
197
|
- **Letting an agent answer comments.** Only when the author asks. Agents read a page's comments with
|
|
198
198
|
`await Pipeup.comments()` (part of Pipeup itself) and answer in a replies file next to the page (`pipeup-apply` is the
|
|
199
199
|
skill for that). Showing those answers in the page is the **agents add-on**, so listing an agent means two things:
|
|
200
|
-
1.
|
|
201
|
-
`data-pipeup-agents
|
|
202
|
-
|
|
200
|
+
1. With the author's yes, the agent lists itself: `npx --yes pipeup@0 agent --name Claude --page page.html --yes`
|
|
201
|
+
adds its public key to `<html>` as `data-pipeup-agents` (appended to an existing list) and changes nothing else.
|
|
202
|
+
Or add a key you were given by hand, keeping every entry. Never write a key you weren't given, and never put an
|
|
203
|
+
agent's private key in the page.
|
|
203
204
|
2. Add the agents add-on after the Pipeup script, pinned with its `integrity` hash like any add-on:
|
|
204
205
|
`<script src="https://cdn.jsdelivr.net/npm/@pipeup/agents@<version>/dist/agents.min.js" integrity="…" crossorigin="anonymous"></script>`,
|
|
205
206
|
and add `agents` to `data-pipeup-addons` if the page has that list. Say in plain words what it does: it reads the
|
|
@@ -207,9 +208,9 @@ page opened from disk and in any script order, and they are released with Pipeup
|
|
|
207
208
|
sends the page's comments to the program on their computer; nothing leaves the computer. It also lets the agent
|
|
208
209
|
reply in threads and mark them addressed, never resolve or change anyone's comment. The page ignores replies from
|
|
209
210
|
keys it doesn't list. Without the add-on the page says so once in the browser console and no replies show.
|
|
210
|
-
On their own computer the author can instead run `npx pipeup watch page.html --agent Claude`: it shows the page with a
|
|
211
|
+
On their own computer the author can instead run `npx --yes pipeup@0 watch page.html --agent Claude`: it shows the page with a
|
|
211
212
|
**Share with my agent** switch (off until they turn it on), lists the agent while it runs, **adds the agents add-on to
|
|
212
|
-
the page it shows itself**, and lets the agent read with `npx pipeup comments page.html`. Nothing is written into the
|
|
213
|
+
the page it shows itself**, and lets the agent read with `npx --yes pipeup@0 comments page.html`. Nothing is written into the
|
|
213
214
|
page file. (It refuses a page whose Pipeup is older than 0.6 and says what to change; a 0.6.x page already has agent
|
|
214
215
|
support built in.)
|
|
215
216
|
- `data-pipeup-live="auto"` makes "Go live" the default, but nobody connects before they have seen the sentence
|
|
@@ -5,7 +5,7 @@ description: Use when someone wants Pipeup reviews saved as Markdown files in th
|
|
|
5
5
|
|
|
6
6
|
# Set up "Save to GitHub" or "Send to Git"
|
|
7
7
|
|
|
8
|
-
Written for Pipeup 0.8.
|
|
8
|
+
Written for Pipeup 0.8.2 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-send-to-git-setup/SKILL.md.
|
|
9
9
|
|
|
10
10
|
Two example add-ons (written the way a company writes its own; **not** from the Pipeup project) get a review into Git as a
|
|
11
11
|
Markdown file, the same Markdown that Copy comments › As Markdown makes (each comment says where it is, ready for an AI to act on):
|
|
@@ -5,7 +5,7 @@ description: Use when someone has Pipeup feedback on an HTML page — text a rev
|
|
|
5
5
|
|
|
6
6
|
# Summarise Pipeup feedback
|
|
7
7
|
|
|
8
|
-
Written for Pipeup 0.8.
|
|
8
|
+
Written for Pipeup 0.8.2 This skill is published at https://pipeup-ai.github.io/pipeup/skills/pipeup-summarise/SKILL.md. Its companions: [integrate](https://pipeup-ai.github.io/pipeup/skills/pipeup-integrate/SKILL.md), [apply](https://pipeup-ai.github.io/pipeup/skills/pipeup-apply/SKILL.md).
|
|
9
9
|
|
|
10
10
|
## 1. Get the feedback as text
|
|
11
11
|
|