You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/pi-notes/README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
# `@henryqw/pi-notes`
2
2
3
-
Persistent notes shown in a Pi widget, managed with slash commands.
3
+
Persistent post-it reminders shown in a Pi widget, managed with slash commands.
4
4
5
5
## Why
6
6
7
-
-**Created for**: Keeping persistent scratch notes visible per worktree without leaving the Pi session.
8
-
-**Advantage**: Slash-command-managed notes render in a widget and survive across sessions without leaking between worktrees.
7
+
-**Created for**: Keeping a few brief, post-it-style reminders visible per worktree without leaving the Pi session.
8
+
-**Advantage**: Notes stay intentionally bounded and visible instead of becoming clipboard storage or history.
9
9
10
10
## Install
11
11
@@ -21,7 +21,7 @@ pi install npm:@henryqw/pi-notes
21
21
|`/note-rm`| command | Pick a note from current worktree to remove. |
22
22
|`/note-clear`| command | Clear current worktree's notes. |
23
23
24
-
Notes are isolated per Git worktree, render as a numbered widget above editor, and persist across sessions under `~/.pi/agent/config/pi-notes/`. Empty worktrees show no widget. Stale files for removed repositories and worktrees are deleted silently when a session starts or notes change.
24
+
Notes are isolated per Git worktree, render as a numbered widget above editor with at most two lines per note, and persist across sessions under `~/.pi/agent/config/pi-notes/`. Empty worktrees show no widget. Stale files for removed repositories and worktrees are deleted silently when a session starts or notes change.
25
25
26
26
Each worktree file is validated as untrusted data. Malformed files are preserved and block mutation for affected worktree until fixed or reset with `/note-clear`.
0 commit comments