@pi-archimedes/notify 2.0.1 → 2.2.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 +15 -23
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,39 +2,33 @@
|
|
|
2
2
|
|
|
3
3
|
Delayed desktop notifications with circuit breaker for the [Pi coding agent](https://github.com/earendil-works/pi).
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Get notified when Pi finishes long tasks or needs an answer, without constant popup spam thanks to delayed firing and raw keypress circuit breaking. You can safely switch windows while long-running jobs execute, knowing a desktop alert will trigger only if you aren't already actively typing in the terminal.
|
|
6
|
+
|
|
7
|
+
## What you get
|
|
6
8
|
|
|
7
9
|
- **Delayed notification** — fires only after a configurable period of inactivity (default 30s), so you're not spammed when actively working
|
|
8
10
|
- **Circuit breaker** — any keystroke immediately cancels a pending notification via raw terminal input listening
|
|
9
|
-
- **Terminal-aware dispatch** — auto-detects your terminal and uses the optimal protocol
|
|
10
|
-
- Kitty → OSC 99 (two-sequence title + body)
|
|
11
|
-
- iTerm2 → OSC 9
|
|
12
|
-
- Windows Terminal → PowerShell toast (ToastText02)
|
|
13
|
-
- Ghostty, WezTerm, others → OSC 777 fallback
|
|
11
|
+
- **Terminal-aware dispatch** — auto-detects your terminal and uses the optimal protocol (OSC 99, OSC 9, OSC 777, or PowerShell toasts)
|
|
14
12
|
- **tmux passthrough** — all sequences wrapped via DCS for correct rendering inside tmux
|
|
15
13
|
- **Per-trigger toggles** — independently enable/disable notifications for task completion and unanswered questions
|
|
16
14
|
- **Bus-driven** — listens for `agent_end` and `ASK_REQUEST` bus events, so it works with any package that emits them
|
|
17
15
|
|
|
18
|
-
##
|
|
19
|
-
|
|
20
|
-
### Kitty notification
|
|
21
|
-
|
|
22
|
-
Notification from Kitty terminal showing title and body via OSC 99:
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
## Installation
|
|
16
|
+
## Install
|
|
27
17
|
|
|
28
18
|
```bash
|
|
29
|
-
pi install
|
|
19
|
+
pi install npm:@pi-archimedes/notify
|
|
30
20
|
```
|
|
31
21
|
|
|
32
|
-
Or install
|
|
22
|
+
Or install full meta package:
|
|
33
23
|
|
|
34
24
|
```bash
|
|
35
|
-
pi install pi-archimedes
|
|
25
|
+
pi install npm:pi-archimedes
|
|
36
26
|
```
|
|
37
27
|
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
When the agent finishes a task (`agent_end`) or a question is asked (`ASK_REQUEST`), a timer starts. If you don't interact for the configured delay, a desktop notification fires. Any keystroke — even just pressing a key without submitting — cancels the timer immediately.
|
|
31
|
+
|
|
38
32
|
## Settings
|
|
39
33
|
|
|
40
34
|
| Setting | Type | Default | Description |
|
|
@@ -42,14 +36,10 @@ pi install pi-archimedes
|
|
|
42
36
|
| `enabled` | bool | `true` | Enable desktop notifications |
|
|
43
37
|
| `notifyOnAgentEnd` | bool | `true` | Notify when agent finishes a task |
|
|
44
38
|
| `notifyOnQuestion` | bool | `true` | Notify when a question needs your answer |
|
|
45
|
-
| `delayMs` | number | `
|
|
39
|
+
| `delayMs` | number | `30000` | Milliseconds to wait before sending notification (default 30 seconds) |
|
|
46
40
|
|
|
47
41
|
Settings are stored in `~/.pi/agent/settings.json` under the `archimedes.notify` namespace.
|
|
48
42
|
|
|
49
|
-
## How it works
|
|
50
|
-
|
|
51
|
-
When the agent finishes a task (`agent_end`) or a question is asked (`ASK_REQUEST`), a timer starts. If you don't interact for the configured delay, a desktop notification fires. Any keystroke — even just pressing a key without submitting — cancels the timer immediately.
|
|
52
|
-
|
|
53
43
|
## Terminal compatibility
|
|
54
44
|
|
|
55
45
|
| Terminal | Protocol | Title + Body |
|
|
@@ -64,3 +54,5 @@ When the agent finishes a task (`agent_end`) or a question is asked (`ASK_REQUES
|
|
|
64
54
|
## Integration
|
|
65
55
|
|
|
66
56
|
When installed via `pi-archimedes` (the meta package), the notify package is automatically registered and its settings appear in the `/archimedes` settings panel. Standalone installs work independently — any package emitting `agent_end` or `ASK_REQUEST` bus events will trigger notifications.
|
|
57
|
+
|
|
58
|
+
← Back to [pi-archimedes](../../README.md)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pi-archimedes/notify",
|
|
3
|
-
"version": "2.0
|
|
3
|
+
"version": "2.2.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"pi-package"
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
".": "./src/index.ts"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@pi-archimedes/core": "2.0
|
|
17
|
+
"@pi-archimedes/core": "2.2.0"
|
|
18
18
|
},
|
|
19
19
|
"peerDependencies": {
|
|
20
20
|
"@earendil-works/pi-coding-agent": ">=0.1.0",
|