@capdiem/pi-todo 0.1.1 → 0.1.3

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.
Files changed (2) hide show
  1. package/README.md +34 -18
  2. package/package.json +7 -3
package/README.md CHANGED
@@ -1,13 +1,16 @@
1
1
  # pi-todo
2
2
 
3
- A minimal, atomic todo tool for the [Pi coding agent](https://pi.dev/). The model
4
- writes the complete task plan in one call instead of issuing one `create` call
5
- per task.
6
-
7
- This is a deliberately small todo tool: it keeps the essential plan-maintenance
8
- core and drops dependencies, reminders, settings menus, and collapse/expand.
9
- It is a good starting point if you want to understand or extend a todo tool
10
- without the production hardening of a full extension.
3
+ A **lightweight**, minimal, atomic todo tool for the [Pi coding agent](https://pi.dev/).
4
+ The model writes the complete task plan in one call instead of issuing one
5
+ `create` call per task.
6
+
7
+ It is deliberately small only the essential plan-maintenance core, with no
8
+ dependencies, reminders, settings menus, or collapse/expand. The live plan
9
+ renders as a read-only widget above Pi's input box, and when hosted by
10
+ [pi-agent-desktop](https://github.com/abcwyc/pi-agent-desktop) it also appears
11
+ in the desktop's **left-nav sidebar** todo panel with zero extra configuration
12
+ (desktop-side support is upcoming — see
13
+ [Desktop integration](#desktop-integration)).
11
14
 
12
15
  ## Features
13
16
 
@@ -22,6 +25,9 @@ without the production hardening of a full extension.
22
25
  - State persists in tool-result details and survives `/reload` and `/tree`
23
26
  - A read-only widget above Pi's input box using markdown-style glyphs
24
27
  (`[ ]` pending, `[-]` in_progress, `[x]` completed); no collapse/expand
28
+ - When hosted by pi-agent-desktop, the live plan also renders in the desktop's
29
+ **left-nav sidebar** todo panel (the desktop-owned `pi-agent-desktop:todo`
30
+ widget extension point) — no extra configuration needed
25
31
 
26
32
  ## Install
27
33
 
@@ -30,10 +36,10 @@ owns the same `todo` tool name before installing it, e.g.:
30
36
 
31
37
  ```bash
32
38
  pi remove <the-other-todo-extension>
33
- pi install npm:pi-todo
39
+ pi install npm:@capdiem/pi-todo
34
40
  ```
35
41
 
36
- During local development:
42
+ To try it without installing:
37
43
 
38
44
  ```bash
39
45
  pi -e ./extensions/pi-todo/index.ts
@@ -115,15 +121,25 @@ are struck through. The widget appears only while a plan exists.
115
121
 
116
122
  ## Desktop integration
117
123
 
118
- In `rpc` mode (e.g. hosted by [pi-agent-desktop](https://github.com/.../pi-agent-desktop)),
119
- the plan is pushed to the host over the desktop-owned **todo widget extension point**
120
- (defined by pi-agent-desktop, see its `lib/todo-state.ts` and
124
+ When hosted by [pi-agent-desktop](https://github.com/abcwyc/pi-agent-desktop)
125
+ (in `rpc` mode), the live plan renders in the desktop's **left-nav sidebar**
126
+ todo panel a persistent checkbox list next to the chat that stays in view
127
+ while you work.
128
+
129
+ The plan is pushed over the desktop-owned **todo widget extension point**
130
+ (defined by pi-agent-desktop; see its `lib/todo-state.ts` and
121
131
  `docs/todo-widget.md`): a `setWidget` request with the desktop-reserved key
122
- `"pi-agent-desktop:todo"`, one JSON `TodoTask` per line. The desktop routes it straight into its
123
- sidebar todo panel. It is fire-and-forget (not persisted); when the desktop
124
- opens a session, this extension's `session_start` restore re-emits the current
125
- plan, so the panel shows the latest snapshot. The TUI keeps its own component
126
- widget (see Rendering) and is unchanged.
132
+ `"pi-agent-desktop:todo"`, one JSON `TodoTask` per line. The desktop routes it
133
+ straight into its sidebar todo panel. It is fire-and-forget (not persisted);
134
+ when the desktop opens a session, this extension's `session_start` restore
135
+ re-emits the current plan, so the panel shows the latest snapshot. The TUI
136
+ keeps its own component widget (see Rendering) and is unchanged.
137
+
138
+ > **Status: the desktop-side panel is upcoming.** The todo-panel support
139
+ > currently lives on a feature branch in pi-agent-desktop and has not been
140
+ > merged into a release yet. `@capdiem/pi-todo` already conforms to the
141
+ > `pi-agent-desktop:todo` widget protocol, so once the panel ships you get the
142
+ > sidebar rendering with **zero extra configuration**.
127
143
 
128
144
  ## Persistence
129
145
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@capdiem/pi-todo",
3
- "version": "0.1.1",
4
- "description": "A minimal atomic todo tool for the Pi coding agent: three states, snapshot updates, stale-write guard, auto-cleanup, and a simple widget",
3
+ "version": "0.1.3",
4
+ "description": "A lightweight atomic todo tool for the Pi coding agent: one-call snapshot plans, three states, stale-write guard, plus a TUI widget and a pi-agent-desktop sidebar panel",
5
5
  "type": "module",
6
6
  "pi": {
7
7
  "extensions": [
@@ -13,7 +13,11 @@
13
13
  "pi",
14
14
  "coding-agent",
15
15
  "todo",
16
- "task-planning"
16
+ "task-planning",
17
+ "lightweight",
18
+ "widget",
19
+ "sidebar",
20
+ "desktop"
17
21
  ],
18
22
  "author": "capdiem <capdiem@live.com>",
19
23
  "license": "MIT",