pi-cue 0.1.1 → 0.1.2

package/README.md

@@ -1,8 +1,8 @@
 # pi-cue
 
-**A tap on your wrist when pi is done, or needs you.**
+**A notification on your iPhone when pi is done, or needs you.**
 
-Pushes to your iPhone and Apple Watch through [Bark](https://github.com/Finb/Bark), but only when you are away. If you are at the keyboard, nothing happens.
+Sent through [Bark](https://github.com/Finb/Bark), and only when you are away: if you are at the keyboard, nothing happens. While the iPhone is locked, it reaches your Apple Watch too.
 
 ## Setup
 
@@ -14,7 +14,7 @@ The key is stored in `~/.pi/agent/cue.json` (mode 600). `PI_CUE_KEY` and `PI_CUE
 
 ## Use
 
-Cues are **off** in every session until you turn them on, so parallel sessions don't all tap you.
+Cues are **off** in every session until you turn them on, so parallel sessions don't all notify you.
 
 | | |
 |---|---|
@@ -40,7 +40,7 @@ The body is the question, the error, or the first line of the answer. The time i
 
 When a background subagent wakes the agent for a quick wrap-up, that still cues: away time counts from your last key press, not from the start of the run. A subagent's question, relayed by the agent as a reply ending in `?`, cues as *Needs you*.
 
-pi does not tell extensions about background work, so the turn that dispatches subagents cues once as *Done* (the body usually says what was dispatched), and each subagent that wakes the agent replaces that notification and taps again.
+pi does not tell extensions about background work, so the turn that dispatches subagents cues once as *Done* (the body usually says what was dispatched), and each subagent that wakes the agent replaces that notification and alerts again.
 
 ## Quiet by design
 
@@ -49,8 +49,6 @@ pi does not tell extensions about background work, so the turn that dispatches s
 - **Cleans up.** Answering, typing, starting a new run, or quitting removes the notification from the phone and watch. Removal needs Bark's *Background App Refresh*.
 - **Never in the way.** Network errors are swallowed. Nested and headless sessions never cue.
 
-The Watch only gets iPhone notifications while the iPhone is locked.
-
 ## Config
 
 `~/.pi/agent/cue.json`, all optional except `key`:

package/index.ts

@@ -1,5 +1,5 @@
 /**
- * pi-cue: a tap on the wrist when pi is done, or needs you.
+ * pi-cue: a phone notification when pi is done, or needs you.
  *
  * Off by default per session; `/cue` turns it on for the current one.
  * All logic lives in src/core.ts; this file only wires pi events to it.
@@ -42,7 +42,7 @@ export default function piCue(pi: ExtensionAPI): void {
 			now: Date.now,
 			after(ms, fn) {
 				const t = setTimeout(fn, ms);
-				t.unref?.(); // never keep pi alive for a tap
+				t.unref?.(); // never keep pi alive for a notification
 				return () => clearTimeout(t);
 			},
 			send(note: Note) {
@@ -77,7 +77,7 @@ export default function piCue(pi: ExtensionAPI): void {
 		cwd = ctx.cwd;
 		sessionId = ctx.sessionManager.getSessionId().slice(0, 8);
 		last = { failed: false, text: "" };
-		if (!ctx.hasUI) return; // nested and headless sessions never tap
+		if (!ctx.hasUI) return; // nested and headless sessions never notify
 		unlisten = ctx.ui.onTerminalInput((data) => {
 			if (isHumanKey(data)) cue.input();
 			return undefined;
@@ -135,11 +135,11 @@ export default function piCue(pi: ExtensionAPI): void {
 		cue.setEnabled(on);
 		pi.appendEntry(ENTRY, { on });
 		showStatus(ctx);
-		say(ctx, on ? (zh ? "cue 已开启:完成或需要你时会推送" : "cue on: you will be tapped when pi is done or needs you") : zh ? "cue 已关闭" : "cue off");
+		say(ctx, on ? (zh ? "cue 已开启:完成或需要你时会推送" : "cue on: you will be notified when pi is done or needs you") : zh ? "cue 已关闭" : "cue off");
 	};
 
 	pi.registerCommand("cue", {
-		description: "Tap on the wrist when pi is done or needs you (on | off | test | key <key>)",
+		description: "Notify your phone when pi is done or needs you (on | off | test | key <key>)",
 		getArgumentCompletions: (prefix) =>
 			["on", "off", "test", "key", "status"].filter((s) => s.startsWith(prefix)).map((s) => ({ value: s, label: s })),
 		handler: async (args, ctx) => {
@@ -160,7 +160,8 @@ export default function piCue(pi: ExtensionAPI): void {
 				}
 				case "test": {
 					if (!cfg.key) return say(ctx, zh ? "还没有 key,先运行 /cue key" : "No key yet. Run /cue key first.", "warning");
-					const m = render({ kind: "done", elapsedMs: 83_000, text: zh ? "这是一条测试" : "This is a test" }, cwd, { zh, detail: true });
+					// Always English: a test is often sent to show someone else what a cue looks like.
+					const m = render({ kind: "done", elapsedMs: 83_000, text: "Test notification from pi-cue. You are all set." }, cwd, { zh: false, detail: true });
 					const ok = await push(cfg, { id: `${id()}-test`, group: repoName(cwd), ...m });
 					return say(ctx, ok ? (zh ? "已发送" : "Sent") : zh ? "发送失败,检查 key 和网络" : "Send failed; check the key and network", ok ? "info" : "error");
 				}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pi-cue",
-  "version": "0.1.1",
-  "description": "A tap on your wrist when pi is done, or needs you. Bark push to iPhone and Apple Watch, only when you are away.",
+  "version": "0.1.2",
+  "description": "Get a notification on your iPhone (and Apple Watch) when pi is done or needs you, only when you are away. Uses Bark.",
   "type": "module",
   "license": "MIT",
   "author": "purboo",

package/src/bark.ts

@@ -98,7 +98,7 @@ async function post(cfg: Config, payload: Record<string, unknown>, fetcher: type
 		});
 		return res.ok;
 	} catch {
-		return false; // best effort: a missed tap must never disturb pi
+		return false; // best effort: a missed notification must never disturb pi
 	}
 }
 

package/src/core.ts

@@ -2,7 +2,7 @@
  * The decision logic, free of pi and the network. Everything time-related and
  * every side effect is injected, so it can be tested with a fake clock.
  *
- * The rule of thumb: a cue is a tap on the wrist, so it must only fire when
+ * The rule of thumb: a cue interrupts you, so it must only fire when
  * you are away. Every cue therefore waits a grace period, and is dropped if
  * you touched the keyboard around that time or the situation resolved itself.
  */