@cad0p/pi-subagents-tintinweb 0.14.2-20260814.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.
package/README.md ADDED
@@ -0,0 +1,639 @@
1
+ # @cad0p/pi-subagents-tintinweb
2
+
3
+ A [pi](https://pi.dev) extension that brings **Claude Code-style autonomous sub-agents** to pi. Spawn specialized agents that run in isolated sessions — each with its own tools, system prompt, model, and thinking level. Run them in foreground or background, steer them mid-run, resume completed sessions, and define your own custom agent types.
4
+
5
+ <img width="600" alt="pi-subagents screenshot" src="https://github.com/tintinweb/pi-subagents/raw/master/media/screenshot.png" />
6
+
7
+
8
+ https://github.com/user-attachments/assets/8685261b-9338-4fea-8dfe-1c590d5df543
9
+
10
+
11
+ ## Features
12
+
13
+ - **Claude Code look & feel** — same tool names, calling conventions, and UI patterns (`Agent`, `get_subagent_result`, `steer_subagent`) — feels native
14
+ - **Parallel background agents** — spawn multiple agents that run concurrently with automatic queuing (configurable concurrency limit, default 4) and smart group join (consolidated notifications)
15
+ - **Live widget UI** — persistent above-editor widget with animated spinners, live tool activity, token counts, and colored status icons. Configurable via `/agents → Settings → Widget`: `all` (every agent), `background` (default — hides foreground runs, which already render inline as the `Agent` tool result), or `off`
16
+ - **FleetView** — Claude Code-style navigable list of `main` + every running subagent rendered below the editor (earliest-launched first). Press `↓` (or `←`) at an empty prompt to jump in, `↑`/`↓` to move the selection, `Enter` to open the selected agent's live, auto-updating conversation, `Esc` to return. Finished agents linger briefly before dropping out, and a viewer stays open through completion so you can read the final output. Toggle via `/agents → Settings → Fleet view`
17
+ - **Conversation viewer** — select any agent in `/agents` to open a live-scrolling overlay of its full conversation (auto-follows new content, scroll up to pause). Steer a running agent inline by pressing `Enter` to open a composer, typing, then `Enter` to send (`Esc` or an empty submit returns) — the message appears as a user message and redirects the agent after its current tool. Stop a still-running agent by pressing `x` (then `x` again to confirm) — both work for background agents too
18
+ - **Custom agent types** — define agents in `.pi/agents/<name>.md` or `.agents/agents/<name>.md` (project) or globally, with YAML frontmatter: custom system prompts, model selection, thinking levels, tool restrictions
19
+ - **Mid-run steering** — inject messages into running agents to redirect their work without restarting
20
+ - **Session resume** — pick up where an agent left off, preserving full conversation context
21
+ - **Graceful turn limits** — agents get a "wrap up" warning before hard abort, producing clean partial results instead of cut-off output
22
+ - **Case-insensitive agent types** — `"explore"`, `"Explore"`, `"EXPLORE"` all work. Unknown types fall back to general-purpose with a note
23
+ - **Fuzzy model selection** — specify models by name (`"haiku"`, `"sonnet"`) instead of full IDs, with automatic filtering to only available/configured models
24
+ - **Context inheritance** — optionally fork the parent conversation into a sub-agent so it knows what's been discussed
25
+ - **Persistent agent memory** — three scopes (project, local, user) with automatic read-only fallback for agents without write tools
26
+ - **Git worktree isolation** — run agents in isolated repo copies; changes auto-committed to branches on completion
27
+ - **Skill preloading** — inject named skills into agent system prompts, discovered from `.pi/skills/`, `.agents/skills/`, and global locations (Pi-standard `<name>/SKILL.md` directory layout supported)
28
+ - **Tool denylist** — block specific tools via `disallowed_tools` frontmatter
29
+ - **Styled completion notifications** — background agent results render as themed, compact notification boxes (icon, stats, result preview) instead of raw XML. Expandable to show full output. Group completions render each agent individually
30
+ - **Event bus** — lifecycle events (`subagents:created`, `started`, `completed`, `failed`, `steered`, `compacted`) emitted via `pi.events`, enabling other extensions to react to sub-agent activity
31
+ - **Cross-extension RPC** — other pi extensions can spawn and stop subagents via the `pi.events` event bus (`subagents:rpc:ping`, `subagents:rpc:spawn`, `subagents:rpc:stop`). Standardized reply envelopes with protocol versioning. Emits `subagents:ready` on session start
32
+ - **Schedule subagents** — pass `schedule` to the `Agent` tool to fire on cron / interval / one-shot. Session-scoped jobs with PID-locked persistence; results land via the same `subagent-notification` followUp path as manual background completions; manage via `/agents → Scheduled jobs`
33
+ - **Model scope enforcement** — opt-in validation that subagent model choices stay within your pi `enabledModels` allowlist (sourced from `/scoped-models`, with both global and project-local pi settings honored). Frontmatter-pinned or parent-inherited out-of-scope → warning + runs anyway (frontmatter authoritative). Toggle via `/agents → Settings → Scope models`
34
+
35
+ ## Install
36
+
37
+ ```bash
38
+ pi install npm:@cad0p/pi-subagents-tintinweb
39
+ ```
40
+
41
+ Or load directly for development:
42
+
43
+ ```bash
44
+ pi -e ./src/index.ts
45
+ ```
46
+
47
+ ## Quick Start
48
+
49
+ The parent agent spawns sub-agents using the `Agent` tool:
50
+
51
+ ```
52
+ Agent({
53
+ subagent_type: "Explore",
54
+ prompt: "Find all files that handle authentication",
55
+ description: "Find auth files",
56
+ run_in_background: true,
57
+ })
58
+ ```
59
+
60
+ Foreground agents block until complete and return results inline. Background agents return an ID immediately and notify you on completion.
61
+
62
+ ### Scheduling
63
+
64
+ Add a `schedule` field to register the agent to fire later instead of running now:
65
+
66
+ ```
67
+ Agent({
68
+ subagent_type: "Explore",
69
+ prompt: "Look at recent commits and summarize what changed since last week",
70
+ description: "Weekly commit review",
71
+ schedule: "0 0 9 * * 1", // 9am every Monday (6-field cron)
72
+ })
73
+ ```
74
+
75
+ Schedule formats:
76
+
77
+ - **Cron** — 6-field (`second minute hour day-of-month month day-of-week`), e.g. `"0 0 9 * * 1"` for 9am every Monday, `"0 */15 * * * *"` for every 15 minutes.
78
+ - **Interval** — `"5m"`, `"1h"`, `"30s"`, `"2d"`. Fires repeatedly at that interval.
79
+ - **One-shot relative** — `"+10m"`, `"+2h"`, `"+1d"`. Fires once at that future time.
80
+ - **One-shot absolute** — full ISO timestamp, e.g. `"2026-12-25T09:00:00.000Z"`.
81
+
82
+ When a schedule fires, the spawn runs in background and its completion notification arrives in the conversation through the same `subagent-notification` followUp path as a manually-spawned background agent — your parent agent reasons about the result the same way.
83
+
84
+ Schedules are **session-scoped**: they reset on `/new` and restore on `/resume`. List and cancel via `/agents → Scheduled jobs` (creation is the `Agent` tool's job — there is no parallel manual-create wizard). Storage at `<cwd>/.pi/subagent-schedules/<sessionId>.json` with PID-based file locking for cross-instance safety.
85
+
86
+ **Disable the feature entirely**: `/agents → Settings → Scheduling → disabled` removes `schedule` from the `Agent` tool spec (no LLM-context cost), hides the menu entry, and stops any active scheduler. The schema-level removal takes effect on the next pi session; the runtime kill is immediate. Re-enable from the same menu.
87
+
88
+ Restrictions:
89
+ - `schedule` cannot be combined with `inherit_context` (no parent conversation exists at fire time) or `resume` (schedules create fresh agents).
90
+ - `run_in_background` is forced to `true`.
91
+ - Scheduled fires bypass the `maxConcurrent` queue so a 5-minute interval cannot be deferred behind long-running manual agents.
92
+ - **Headless `pi -p` doesn't wait for scheduled subagents.**
93
+
94
+ ## UI
95
+
96
+ The extension renders a persistent widget above the editor showing active agents. By default it shows background runs only (`widgetMode: background`) — foreground agents already render inline as the `Agent` tool result, so the widget would otherwise double-render them. Switch to `all` (every agent) or `off` (hide the widget) via `/agents → Settings → Widget`:
97
+
98
+ ```
99
+ ● Agents
100
+ ├─ ⠹ Agent Refactor auth module · ↻5≤30 · 5 tool uses · 33.8k token (62%) · 12.3s
101
+ │ ⎿ editing 2 files…
102
+ ├─ ⠹ Explore Find auth files · ↻3 · 3 tool uses · 12.4k token (8%) · 4.1s
103
+ │ ⎿ searching…
104
+ ├─ ⠹ Agent Long-running task · ↻42 · 38 tool uses · 91.0k token (84% · ⇊2) · 2m17s
105
+ │ ⎿ reading…
106
+ └─ 2 queued
107
+ ```
108
+
109
+ The token field is annotated with two optional signals inside parens:
110
+ - **`NN%`** — context-window utilization (color-coded: <70% dim, 70–85% warning, ≥85% error). Omitted when the model has no declared `contextWindow`, or briefly right after compaction.
111
+ - **`⇊N`** — number of times the session has compacted, when > 0. Stays dim; the percent's color carries urgency.
112
+
113
+ ### FleetView
114
+
115
+ While subagents are running, a Claude Code-style navigable list renders **below** the editor:
116
+
117
+ ```
118
+ esc to interrupt · ← for agents · ↓ to manage
119
+
120
+ ⏺ main
121
+ ◯ general-purpose Sleep then report 1 11s · ↓ 13.1k tokens
122
+ ◯ general-purpose Sleep then report 2 11s · ↓ 13.1k tokens
123
+ ↓ 3 more
124
+ ```
125
+
126
+ The list is ordered earliest-launched first, and only shows agents you can actually open (pending/queued agents with no session yet appear once they start). At an **empty prompt**, press `↓` (or `←`) to move focus from the prompt into the list — the selected row is marked `⏺`, the rest `◯`. `↑`/`↓` move the selection, `Enter` opens the selected agent's live conversation overlay (it auto-updates as the agent works), and `Esc` (or `↑` above `main`) returns to the prompt. Selecting `main` returns to the normal view. Inside the overlay, press `Enter` to steer the running agent — type a message and `Enter` to send it (`Esc` or an empty submit returns), and it redirects the agent the same way the `steer_subagent` tool does. A viewer stays open when its agent finishes so you can read the final output, and finished agents linger in the list for a few seconds before dropping out. Typing anything at a non-empty prompt behaves normally — the list only captures arrow keys when the prompt is empty. Disable it entirely via `/agents → Settings → Fleet view`.
127
+
128
+ Individual agent results render Claude Code-style in the conversation:
129
+
130
+ | State | Example |
131
+ |-------|---------|
132
+ | **Running** | `⠹ ↻3≤30 · 3 tool uses · 12.4k token (8%)` / `⎿ searching, reading 3 files…` |
133
+ | **Completed** | `✓ ↻8 · 5 tool uses · 33.8k token (62%) · 12.3s` / `⎿ Done` |
134
+ | **Wrapped up** | `✓ ↻50≤50 · 50 tool uses · 89.1k token (84% · ⇊2) · 45.2s` / `⎿ Wrapped up (turn limit)` |
135
+ | **Stopped** | `■ ↻3 · 3 tool uses · 12.4k token (8%)` / `⎿ Stopped` |
136
+ | **Error** | `✗ ↻3 · 3 tool uses · 12.4k token (8%)` / `⎿ Error: timeout` |
137
+ | **Aborted** | `✗ ↻55≤50 · 55 tool uses · 102.3k token (95% · ⇊3)` / `⎿ Aborted (max turns exceeded)` |
138
+
139
+ Completed results can be expanded (ctrl+o in pi) to show the full agent output inline.
140
+
141
+ By default, foreground and background agents each stream their full conversation to a per-subagent transcript — a JSON-lines file at `<os-tmpdir>/pi-subagents-<uid>/<cwd>/<session>/tasks/<agent-id>.output` (owner-only `0700`, cleared on reboot). Set `output_transcript: false` on a custom agent to write no transcript path or file for it, or set `outputTranscript: false` in `subagents.json` to make transcripts opt-in for the whole project (frontmatter overrides the project default). This governs **only** the transcript: it is independent of `persist_session` (the pi session on disk), and it does not affect `isolation: worktree` (which commits the agent's work to a git branch) or `memory:` (durable files) — set those accordingly if the goal is to keep a run off disk entirely. Background agent completion notifications render as styled boxes:
142
+
143
+ ```
144
+ ✓ Find auth files completed
145
+ ↻3 · 3 tool uses · 12.4k token · 4.1s
146
+ ⎿ Found 5 files related to authentication...
147
+ transcript: .pi/output/agent-abc123.jsonl
148
+ ```
149
+
150
+ Group completions render each agent as a separate block. The LLM receives structured `<task-notification>` XML for parsing, while the user sees the themed visual.
151
+
152
+ ## Default Agent Types
153
+
154
+ | Type | Tools | Model | Prompt Mode | Description |
155
+ |------|-------|-------|-------------|-------------|
156
+ | `general-purpose` | all 7 | inherit | `append` (parent twin) | Inherits the parent's full system prompt — same rules, CLAUDE.md, project conventions |
157
+ | `Explore` | read, bash, grep, find, ls | haiku (falls back to inherit) | `replace` (standalone) | Fast codebase exploration (read-only) |
158
+ | `Plan` | read, bash, grep, find, ls | inherit | `replace` (standalone) | Software architect for implementation planning (read-only) |
159
+
160
+ The `general-purpose` agent is a **parent twin** — it receives the parent's entire system prompt plus a sub-agent context bridge, so it follows the same rules the parent does. Explore and Plan use standalone prompts tailored to their read-only roles.
161
+
162
+ Default agents can be **ejected** (`/agents` → select agent → Eject) to export them as `.md` files for customization, **overridden** by creating a `.md` file with the same name (e.g. `.pi/agents/general-purpose.md`), or **disabled** per-project with `enabled: false` frontmatter.
163
+
164
+ ## Custom Agents
165
+
166
+ Define custom agent types by creating `.md` files. The filename becomes the agent type name. Any name is allowed — using a default agent's name overrides it.
167
+
168
+ Agents are discovered from three locations (higher priority wins):
169
+
170
+ | Priority | Location | Scope |
171
+ |----------|----------|-------|
172
+ | 1 (highest) | `.pi/agents/<name>.md` | Project — pi's config dir; authoritative, and where `/agents` writes |
173
+ | 2 | `.agents/agents/<name>.md` | Project — the shared cross-tool `.agents` workspace (same convention as `.agents/skills/`) |
174
+ | 3 | `$PI_CODING_AGENT_DIR/agents/<name>.md` (default `~/.pi/agent/agents/<name>.md`) | Global — available everywhere |
175
+
176
+ Project-level agents override global ones with the same name, so you can customize a global agent for a specific project. If both project locations define the same name, **`.pi/agents/` wins** — `.pi` stays the project authority; `.agents/agents/` is an additional read location for projects that keep their agent assets in the `.agents` workspace. The global location follows the upstream `PI_CODING_AGENT_DIR` env var — set it to relocate all pi-coding-agent state (agents, skills, settings) to a custom directory.
177
+
178
+ ### Example: `.pi/agents/auditor.md`
179
+
180
+ ```markdown
181
+ ---
182
+ description: Security Code Reviewer
183
+ tools: read, grep, find, bash
184
+ model: anthropic/claude-opus-4-6
185
+ thinking: high
186
+ max_turns: 30
187
+ ---
188
+
189
+ You are a security auditor. Review code for vulnerabilities including:
190
+ - Injection flaws (SQL, command, XSS)
191
+ - Authentication and authorization issues
192
+ - Sensitive data exposure
193
+ - Insecure configurations
194
+
195
+ Report findings with file paths, line numbers, severity, and remediation advice.
196
+ ```
197
+
198
+ Then spawn it like any built-in type:
199
+
200
+ ```
201
+ Agent({ subagent_type: "auditor", prompt: "Review the auth module", description: "Security audit" })
202
+ ```
203
+
204
+ ### Frontmatter Fields
205
+
206
+ All fields are optional — sensible defaults for everything.
207
+
208
+ | Field | Default | Description |
209
+ |-------|---------|-------------|
210
+ | `description` | filename | Agent description shown in tool listings |
211
+ | `display_name` | — | Display name for UI (e.g. widget, agent list) |
212
+ | `tools` | all 7 | Which tools the agent can call. Built-in names (`read, grep, …`), `*` / `all` (all built-ins), `none`, and `ext:<extension>` / `ext:<extension>/<tool>` selectors for extension tools. See [Tool & extension scoping](#tool--extension-scoping) below |
213
+ | `extensions` | `true` | Which extensions to load for the agent. `true` (all defaults), `false` (none), or an explicit list: `[mcp, "/abs/path.ts", "*"]`. See [Tool & extension scoping](#tool--extension-scoping) below |
214
+ | `exclude_extensions` | — | Extension denylist applied after `extensions:` — exclude wins. Plain names only (case-insensitive), no paths or `*`. Useful with `extensions: true` to drop one extension (e.g. `pi-notify`) |
215
+ | `skills` | `true` | Inherit skills from parent. Can be a comma-separated list of skill names to preload (see [Skill Preloading](#skill-preloading) for discovery locations) |
216
+ | `memory` | — | Persistent agent memory scope: `project`, `local`, or `user`. Auto-detects read-only agents |
217
+ | `disallowed_tools` | — | Comma-separated tools to deny even if extensions provide them |
218
+ | `isolation` | — | Set to `worktree` to run in an isolated git worktree |
219
+ | `model` | inherit parent | Model — `provider/modelId` or fuzzy name (`"haiku"`, `"sonnet"`). Resolved tolerantly (`.`/`-` and a trailing date stamp are interchangeable) and falls back to the same model under another provider if the named one doesn't have it |
220
+ | `thinking` | inherit | off, minimal, low, medium, high, xhigh, max — actual availability depends on your pi version and model; pi clamps unsupported levels down |
221
+ | `max_turns` | unlimited | Max agentic turns before graceful shutdown. `0` or omit for unlimited |
222
+ | `persist_session` | `false` | Persist this subagent as a normal pi session instead of keeping the session in memory only. The subagent's `.output` transcript is still written either way unless `output_transcript: false` |
223
+ | `output_transcript` | `true` (or `subagents.json` `outputTranscript`) | Write this subagent's `.output` transcript; when set, overrides the `subagents.json` `outputTranscript` default. Set `false` to write no transcript file or path. Governs only the transcript — independent of `persist_session`, `isolation: worktree`, and `memory:` |
224
+ | `session_dir` | pi default | Optional session directory when `persist_session: true`; omitted uses pi's normal session location, and relative paths resolve from the agent cwd |
225
+ | `prompt_mode` | `replace` | `replace`: body is the full system prompt (no AGENTS.md / CLAUDE.md inheritance). `append`: body appended to parent's prompt (agent acts as a "parent twin" — inherits parent's AGENTS.md / CLAUDE.md) |
226
+ | `inherit_context` | `false` | Fork parent conversation into agent |
227
+ | `run_in_background` | `false` | Run in background by default |
228
+ | `isolated` | `false` | Hermetic specialist mode: forces `extensions: false` + `skills: false` + drops `ext:` selectors. Only built-in tools. Distinct from `isolation: worktree` (filesystem) |
229
+ | `enabled` | `true` | Set to `false` to disable an agent (useful for hiding a default agent per-project) |
230
+
231
+ Frontmatter is authoritative. If an agent file sets `model`, `thinking`, `max_turns`, `inherit_context`, `run_in_background`, `isolated`, or `isolation`, those values are locked for that agent. `Agent` tool parameters only fill fields the agent config leaves unspecified.
232
+
233
+ **Forgiving `model:` resolution.** A `model:` pin is matched against pi's model registry tolerantly, so cosmetic id variations don't silently drop the agent back to the parent's model: `.` and `-` are treated as equivalent in version numbers (`claude-haiku-4.5` ≡ `claude-haiku-4-5`), a trailing `-YYYYMMDD` date stamp is optional (`anthropic/claude-haiku-4-5-20251001` matches an undated registry id and vice-versa), and a `provider/modelId` whose named provider doesn't carry that model retries the bare id against every provider. Precedence is **exact → fuzzy under the named provider → same model under any provider → unavailable**, so an exact match always wins and dated snapshots aren't conflated. If nothing resolves, the pin can't run and the agent inherits the parent model — `/agents → Agent types` flags this case as `(unavailable, fallback: inherit)` and shows the resolved target `(→ provider/id)` when resolution lands on a different provider or version than configured. (This is distinct from [Model Scope](#model-scope) enforcement, which matches the `enabledModels` allowlist by *exact* entry.)
234
+
235
+ ### Tool & extension scoping
236
+
237
+ `extensions:` decides **which extensions load**, `tools:` decides **which tools surface to the LLM**. They compose:
238
+
239
+ ```yaml
240
+ # Default (both omitted): all extensions load, all 7 built-ins surface
241
+
242
+ tools: read, grep, find # narrow to listed built-ins; extensions still load
243
+ tools: "*" # all 7 built-ins (alias: `all`)
244
+ tools: none # zero built-ins (alias: `""`)
245
+ tools: "*, ext:mcp/search" # built-ins plus one extension tool
246
+
247
+ extensions: false # no extensions load
248
+ extensions: [mcp] # only mcp loads
249
+ extensions: ["*", "/abs/foo.ts"] # all defaults plus one path-loaded extension
250
+
251
+ exclude_extensions: pi-notify # everything except pi-notify (with extensions: true)
252
+
253
+ # Specialist: load one extension, expose only one of its tools, keep built-ins
254
+ extensions: [mcp]
255
+ tools: "*, ext:mcp/search"
256
+
257
+ isolated: true # hermetic: built-ins only, no extensions/skills/context
258
+ ```
259
+
260
+ A few rules the examples don't make obvious:
261
+
262
+ - `extensions:` is the sole loading authority. `ext:foo` in `tools:` narrows what surfaces; it can't load `foo` on its own. Mismatches fire `extension-error:…` warnings.
263
+ - Any `ext:` entry flips extension tools to an explicit allowlist — unnamed extensions still load (handlers fire) but expose no tools. So `tools: "*, ext:mcp/search"` exposes only `search` from `mcp`, nothing from any other extension.
264
+ - Extension names match case-insensitively (`[Mcp]` = `[mcp]`); tool names in `ext:foo/bar` stay case-sensitive.
265
+ - An installed **package** extension matches by its package short name (`@scope/pi-subagents` → `[pi-subagents]`), in addition to its path-derived name (a package whose entry is `src/index.ts` also answers to `[src]`). Prefer the package name — the path-derived one is incidental.
266
+ - Plain `tools:` typos fail loudly: `tools: reed, grep` fires `tools-error:…` instead of silently producing an under-tooled agent.
267
+ - `exclude_extensions:` wins over `extensions:` and over `ext:` selectors — an excluded extension never loads and a `tools: ext:` entry can't pull it back. Plain names only (no paths, no `*`); a name matching nothing fires an `extension-error:…` warning.
268
+ - `exclude_extensions:` is **not a sandbox**: excluded extensions' factory code still executes once during loading. Exclusion suppresses their tools and their bound lifecycle hooks (`pi.on` handlers like `session_start` only fire for extensions bound to the session), but not other load-time side effects — a factory that subscribes directly to the shared `pi.events` bus stays live. Don't rely on it to contain an untrusted extension.
269
+ - Array and string forms are equivalent: `[a, b]` == `"a, b"`.
270
+
271
+ ## Tools
272
+
273
+ ### `Agent`
274
+
275
+ Launch a sub-agent.
276
+
277
+ | Parameter | Type | Required | Description |
278
+ |-----------|------|----------|-------------|
279
+ | `prompt` | string | yes | The task for the agent |
280
+ | `description` | string | yes | Short 3-5 word summary (shown in UI) |
281
+ | `subagent_type` | string | yes | Agent type (built-in or custom) |
282
+ | `thinking` | string | no | Thinking level: off, minimal, low, medium, high, xhigh, max (availability depends on pi version and model) |
283
+ | `max_turns` | number | no | Max agentic turns. Omit for unlimited (default) |
284
+ | `run_in_background` | boolean | no | Run without blocking |
285
+ | `resume` | string | no | Agent ID to resume a previous session |
286
+ | `isolated` | boolean | no | No extension/MCP tools |
287
+ | `isolation` | `"worktree"` | no | Run in an isolated git worktree |
288
+ | `inherit_context` | boolean | no | Fork parent conversation into agent |
289
+
290
+ ### `get_subagent_result`
291
+
292
+ Check status and retrieve results from a background agent.
293
+
294
+ | Parameter | Type | Required | Description |
295
+ |-----------|------|----------|-------------|
296
+ | `agent_id` | string | yes | Agent ID to check |
297
+
298
+ ### `steer_subagent`
299
+
300
+ Send a steering message to a running agent. The message interrupts after the current tool execution.
301
+
302
+ | Parameter | Type | Required | Description |
303
+ |-----------|------|----------|-------------|
304
+ | `agent_id` | string | yes | Agent ID to steer |
305
+ | `message` | string | yes | Message to inject into agent conversation |
306
+
307
+ ### `checkpoint`
308
+
309
+ Subagent-facing: a subagent calls this at milestones to save a one-sentence progress summary for the parent. The latest summary is surfaced inline in `get_subagent_result`'s output; the full history lives in a `.checkpoints.md` file alongside the `.output` transcript.
310
+
311
+ | Parameter | Type | Required | Description |
312
+ |-----------|------|----------|-------------|
313
+ | `summary` | string | yes | 1-2 sentences: what you just did, what you're doing next |
314
+
315
+ ## Commands
316
+
317
+ | Command | Description |
318
+ |---------|-------------|
319
+ | `/agents` | Interactive agent management menu |
320
+
321
+ The `/agents` command opens an interactive menu:
322
+
323
+ ```
324
+ Running agents (2) — 1 running, 1 done ← only shown when agents exist
325
+ Agent types (6) ← unified list: defaults + custom
326
+ Create new agent ← manual wizard or AI-generated
327
+ Settings ← max concurrency, max turns, grace turns, join mode
328
+ ```
329
+
330
+ - **Running agents** — select one to open its live conversation viewer. While it's still running, press `Enter` to open the steering composer, then `Enter` again to send a message that redirects the agent (same mechanism as the `steer_subagent` tool; `Esc` or an empty submit returns), or press `x` (then `x` again to confirm) to stop/abort it — including **background** agents, which a global Esc can't unambiguously target (Esc still stops a blocking foreground `Agent` call). A stopped agent reports its partial output flagged as incomplete, not as a completion.
331
+ - **Agent types** — unified list with source indicators: `•` (project), `◦` (global), `✕` (disabled). Each row shows the agent's model, and the highlighted agent's full description appears below the list. The model column flags `(unavailable, fallback: inherit)` when a configured model can't be resolved (it would silently inherit the parent model), and shows `(→ provider/id)` when it resolves to a different provider or version than configured. Select an agent to manage it:
332
+ - **Default agents** (no override): Eject (export as `.md`), Disable
333
+ - **Default agents** (ejected/overridden): Edit, Disable, Reset to default, Delete
334
+ - **Custom agents**: Edit, Disable, Delete
335
+ - **Disabled agents**: Enable, Edit, Delete
336
+ - **Eject** — writes the embedded default config as a `.md` file to project or personal location, so you can customize it
337
+ - **Disable/Enable** — toggle agent availability. Disabled agents stay visible in the list (marked `✕`) and can be re-enabled
338
+ - **Create new agent** — choose project/personal location, then manual wizard (step-by-step prompts for name, tools, model, thinking, system prompt) or AI-generated (describe what the agent should do and a sub-agent writes the `.md` file). Any name is allowed, including default agent names (overrides them)
339
+ - **Settings** — configure max concurrency, default max turns, grace turns, and join mode at runtime
340
+
341
+ ## Graceful Max Turns
342
+
343
+ Instead of hard-aborting at the turn limit, agents get a graceful shutdown:
344
+
345
+ 1. At `max_turns` — steering message: *"Wrap up immediately — provide your final answer now."*
346
+ 2. Up to 5 grace turns to finish cleanly
347
+ 3. Hard abort only after the grace period
348
+
349
+ | Status | Meaning | Icon |
350
+ |--------|---------|------|
351
+ | `completed` | Finished naturally | `✓` green |
352
+ | `steered` | Hit limit, wrapped up in time | `✓` yellow |
353
+ | `aborted` | Grace period exceeded | `✗` red |
354
+ | `stopped` | User-initiated abort | `■` dim |
355
+
356
+ ## Concurrency
357
+
358
+ Background agents are subject to a configurable concurrency limit (default: 4). Excess agents are automatically queued and start as running agents complete. The widget shows queued agents as a collapsed count.
359
+
360
+ Foreground agents bypass the queue — they block the parent anyway.
361
+
362
+ ## Join Strategies
363
+
364
+ When background agents complete, they notify the main agent. The **join mode** controls how these notifications are delivered. It applies only to background agents.
365
+
366
+ | Mode | Behavior |
367
+ |------|----------|
368
+ | `smart` (default) | 2+ background agents spawned in the same turn are auto-grouped into a single consolidated notification. Solo agents notify individually. |
369
+ | `async` | Each agent sends its own notification on completion (original behavior). Best when results need incremental processing. |
370
+ | `group` | Force grouping even when spawning a single agent. Useful when you know more agents will follow. |
371
+
372
+ **Timeout behavior:** When agents are grouped, a 30-second timeout starts after the first agent completes. If not all agents finish in time, a partial notification is sent with completed results and remaining agents continue with a shorter 15-second re-batch window for stragglers.
373
+
374
+ **Configuration:**
375
+ - Configure join mode in `/agents` → Settings → Join mode
376
+
377
+ ## Model Scope
378
+
379
+ **Opt-in:** off by default. Enable via `/agents → Settings → Scope models`.
380
+
381
+ When on, each subagent spawn's effective model is validated against pi's own `enabledModels` list (configured via pi's `/scoped-models` UI). pi-subagents reads that list; it doesn't manage it. Both of pi's settings files are honored: global `~/.pi/agent/settings.json` and project-local `<cwd>/.pi/settings.json`. **Project overrides global** — mirrors pi's `SettingsManager` deep-merge, so a tighter per-project scope (hand-edited into the project settings) is respected.
382
+
383
+ **Out-of-scope handling depends on source:**
384
+
385
+ | Model source | Out-of-scope behavior |
386
+ |---|---|
387
+ | Pinned in agent frontmatter | Warning toast + the pinned model runs (frontmatter is authoritative) |
388
+ | Parent-inherited (frontmatter sets no model) | Warning toast + parent's model runs |
389
+
390
+ **Design:** `scopeModels` is a guardrail against frontmatter-pinned or parent-inherited models drifting out of the user's allowlist. The "frontmatter is authoritative" guarantee from v0.5.1 still holds for `model:` — frontmatter pins run even when out of scope (with a visible warning).
391
+
392
+ **Pattern format:** only exact `provider/modelId` entries are honored (e.g. `anthropic/claude-haiku-4-5-20251001`). Glob patterns (`*sonnet*`), bare model IDs, and `:thinking` suffixes — which pi itself supports — are silently dropped here. pi's `/scoped-models` picker writes exact entries, so the limitation is invisible if you configure scope through the UI. Hand-edited globs produce an empty allowed set (scope check becomes a no-op).
393
+
394
+ **No-op safety:** if `enabledModels` is missing or empty in pi's settings, scope check skips entirely — no false positives, no spurious errors.
395
+
396
+ ## Persistent Settings
397
+
398
+ Runtime tuning values set via `/agents` → Settings (max concurrency, default max turns, grace turns, default join mode, scheduling on/off, scope models on/off, disable defaults on/off, output transcript on/off, tool description full/compact/custom, widget all/background/off) persist across pi restarts. Two files, merged on load:
399
+
400
+ - **Global:** `~/.pi/agent/subagents.json` — your machine-wide defaults. Edit by hand; the `/agents` menu never writes here.
401
+ - **Project:** `<cwd>/.pi/subagents.json` — per-project overrides. Written by `/agents` → Settings.
402
+
403
+ **Precedence:** project overrides global on any field present in both. Missing fields fall back to the hardcoded defaults (max concurrency `4`, default max turns unlimited, grace turns `5`, join mode `smart`, defaults enabled).
404
+
405
+ **Disable defaults** (`disableDefaultAgents`, default `false`): when on, the three built-in agents (general-purpose, Explore, Plan) are not registered — only your project/global custom agents are advertised and spawnable. User-defined agents are unaffected, including ones that override a default by name. The Agent tool's type list updates on the next pi session (the tool schema is registered at startup).
406
+
407
+ **Output transcript** (`outputTranscript`, default `true`): the project/global default for writing each subagent's `.output` transcript. Toggle via `/agents → Settings → Output transcript`, or set `false` in `subagents.json` to make transcripts opt-in project-wide — useful when run transcripts shouldn't sit on disk for backup or DLP tooling to pick up. A custom agent's `output_transcript` frontmatter overrides this per agent. Applied live at spawn time. Governs only the transcript, not `persist_session`, worktree commits, or memory files.
408
+
409
+ **Tool description** (`toolDescriptionMode`, default `"full"`): which Agent tool description the LLM sees. `"full"` is the rich Claude Code-style prompt (~1,400 tokens with the default agents); `"compact"` is ~75% smaller — one-line agent type list, terse usage notes — for small/local models where tool-spec tokens are expensive. Per-option details stay in the parameter descriptions in every mode (the parameter schema is never customizable). Applies on the next pi session.
410
+
411
+ `"custom"` registers your own description from `<cwd>/.pi/agent-tool-description.md` (project) or `<agentDir>/agent-tool-description.md` (global; project wins). The file is read once at tool registration, so edits also apply on the next pi session. Dynamic parts stay live via placeholders — a static agent list would go stale the moment you add a custom agent:
412
+
413
+ ```markdown
414
+ Launch an autonomous agent. Available types:
415
+ {{typeList}}
416
+
417
+ Custom agents live in .pi/agents/ or {{agentDir}}/agents/.
418
+ ```
419
+
420
+ Placeholders: `{{typeList}}` (full per-agent descriptions), `{{compactTypeList}}` (first sentence each), `{{agentDir}}`, `{{scheduleGuideline}}` (expands with its own leading newline + `- ` bullet when scheduling is on — place it directly after your last rule line; empty when scheduling is off). Unknown placeholders are left verbatim with a stderr warning; a missing or empty file falls back to `"full"` with a warning. Note the usual trust umbrella: a project-level file shapes the orchestrator's prompt, same as project agents and extensions do.
421
+
422
+ **Starting point:** copy [`examples/agent-tool-description.md`](examples/agent-tool-description.md) — it reproduces the default full description exactly (a CI test keeps it in sync), so you can trim from a known-good baseline instead of writing from scratch.
423
+
424
+ **Example — global defaults for a beefy machine:**
425
+
426
+ ```bash
427
+ mkdir -p ~/.pi/agent
428
+ cat > ~/.pi/agent/subagents.json <<'EOF'
429
+ {
430
+ "maxConcurrent": 16,
431
+ "graceTurns": 10
432
+ }
433
+ EOF
434
+ ```
435
+
436
+ Every project now starts with concurrency 16 and grace 10, without ever touching the menu. Individual projects can still override via `/agents` → Settings.
437
+
438
+ **Failure behavior:** missing file is silent; malformed JSON logs a `[pi-subagents] Ignoring malformed settings at …` warning to stderr; invalid/out-of-range field values are dropped per-field; write failures downgrade the `/agents` toast to a warning with `(session only; failed to persist)`.
439
+
440
+ ## Events
441
+
442
+ Agent lifecycle events are emitted via `pi.events.emit()` so other extensions can react:
443
+
444
+ | Event | When | Key fields |
445
+ |-------|------|------------|
446
+ | `subagents:created` | Background agent registered | `id`, `type`, `description`, `isBackground` |
447
+ | `subagents:started` | Agent transitions to running (including queued→running) | `id`, `type`, `description` |
448
+ | `subagents:completed` | Agent finished successfully (background and foreground) | `id`, `type`, `durationMs`, `tokens` (lifetime `{ input, output, total }`), `toolUses`, `result` |
449
+ | `subagents:failed` | Agent errored, stopped, or aborted (background and foreground) | same as completed + `error`, `status` |
450
+ | `subagents:steered` | Steering message sent | `id`, `message` |
451
+ | `subagents:compacted` | Agent's session successfully compacted | `id`, `type`, `description`, `reason` (`"manual"` / `"threshold"` / `"overflow"`), `tokensBefore`, `compactionCount` |
452
+ | `subagents:scheduled` | Schedule lifecycle change | `{ type: "added" \| "removed" \| "updated" \| "fired" \| "error", … }` (job/agentId/error fields per type) |
453
+ | `subagents:scheduler_ready` | Scheduler bound to session, enabled jobs armed | `sessionId`, `jobCount` |
454
+ | `subagents:ready` | RPC handlers registered and armed — fired on session start; not emitted in a session that excludes pi-subagents | — |
455
+ | `subagents:settings_loaded` | Persisted settings applied at extension init | `settings` (merged global + project) |
456
+ | `subagents:settings_changed` | `/agents` → Settings mutation was applied | `settings`, `persisted` (`boolean` — `false` on write failure) |
457
+
458
+ `tokens.total` = `input + output + cacheWrite`. `cacheRead` is excluded — each turn's `cacheRead` is the cumulative cached prefix re-read on that one API call, so summing per-message would over-count it. Use `contextUsage.percent` (surfaced as `(NN%)` in the widget) for current context size.
459
+
460
+ ## Cross-Extension RPC
461
+
462
+ Other pi extensions can spawn and stop subagents programmatically via the `pi.events` event bus, without importing this package directly.
463
+
464
+ All RPC replies use a standardized envelope: `{ success: true, data?: T }` on success, `{ success: false, error: string }` on failure.
465
+
466
+ ### Discovery
467
+
468
+ Listen for `subagents:ready` to know when RPC handlers are available:
469
+
470
+ ```typescript
471
+ pi.events.on("subagents:ready", () => {
472
+ // RPC handlers are registered — safe to call ping/spawn/stop
473
+ });
474
+ ```
475
+
476
+ `subagents:ready` fires only when pi-subagents is actually loaded **and bound** in the current session. A session that excludes it (via an agent's `extensions:`) emits no `subagents:ready` and does not answer the RPC channels — exactly as if pi-subagents were not installed. Treat "no `subagents:ready`" as "not available here" and give discovery a timeout rather than waiting indefinitely.
477
+
478
+ ### Ping
479
+
480
+ Check if the subagents extension is loaded and get the protocol version:
481
+
482
+ ```typescript
483
+ const requestId = crypto.randomUUID();
484
+ const unsub = pi.events.on(`subagents:rpc:ping:reply:${requestId}`, (reply) => {
485
+ unsub();
486
+ if (reply.success) console.log("Protocol version:", reply.data.version);
487
+ });
488
+ pi.events.emit("subagents:rpc:ping", { requestId });
489
+ ```
490
+
491
+ ### Spawn
492
+
493
+ Spawn a subagent and receive its ID:
494
+
495
+ ```typescript
496
+ const requestId = crypto.randomUUID();
497
+ const unsub = pi.events.on(`subagents:rpc:spawn:reply:${requestId}`, (reply) => {
498
+ unsub();
499
+ if (!reply.success) {
500
+ console.error("Spawn failed:", reply.error);
501
+ } else {
502
+ console.log("Agent ID:", reply.data.id);
503
+ }
504
+ });
505
+ pi.events.emit("subagents:rpc:spawn", {
506
+ requestId,
507
+ type: "general-purpose",
508
+ prompt: "Do something useful",
509
+ options: { description: "My task", run_in_background: true },
510
+ });
511
+ ```
512
+
513
+ `options.model` accepts either a `Model` object (e.g. `ctx.model`) or a `"provider/modelId"` string — strings are resolved against `ctx.modelRegistry` at the RPC boundary, so cross-extension callers can forward serializable values without losing auth context.
514
+
515
+ `options.cwd` (absolute path to an existing directory — anything else returns an error envelope; `null` means unset) runs the agent in a different working directory than the parent session. Its tools operate there and the prompt's environment block describes it, but **`.pi` config still loads from the parent session's project** — the target directory's `.pi` extensions never execute, and its agents/skills/settings are not picked up. Combined with `isolation: "worktree"`, the worktree is created *from* the target directory's repo, the agent works at the equivalent subdirectory inside the copy (a monorepo-package cwd stays scoped to that package), and the resulting `pi-agent-*` branch lands in that repo — the completion message names it. On session end, worktree registrations are pruned in every repo that received one; only a hard crash can leave a stale entry (then: `git worktree prune` in the target repo). Agents with `memory:` keep reading/writing the parent project's memory.
516
+
517
+ ### Stop
518
+
519
+ Stop a running agent by ID:
520
+
521
+ ```typescript
522
+ const requestId = crypto.randomUUID();
523
+ const unsub = pi.events.on(`subagents:rpc:stop:reply:${requestId}`, (reply) => {
524
+ unsub();
525
+ if (!reply.success) console.error("Stop failed:", reply.error);
526
+ });
527
+ pi.events.emit("subagents:rpc:stop", { requestId, agentId: "agent-id-here" });
528
+ ```
529
+
530
+ Reply channels are scoped per `requestId`, so concurrent requests don't interfere.
531
+
532
+ ## Persistent Agent Memory
533
+
534
+ Agents can have persistent memory across sessions. Set `memory` in frontmatter to enable:
535
+
536
+ ```yaml
537
+ ---
538
+ memory: project # project | local | user
539
+ ---
540
+ ```
541
+
542
+ | Scope | Location | Use case |
543
+ |-------|----------|----------|
544
+ | `project` | `.pi/agent-memory/<name>/` | Shared across the team (committed) |
545
+ | `local` | `.pi/agent-memory-local/<name>/` | Machine-specific (gitignored) |
546
+ | `user` | `~/.pi/agent-memory/<name>/` | Global personal memory |
547
+
548
+ Memory uses a `MEMORY.md` index file and individual memory files with frontmatter. Agents with write tools get full read-write access. **Read-only agents** (no `write`/`edit` tools) automatically get read-only memory — they can consume memories written by other agents but cannot modify them. This prevents unintended tool escalation.
549
+
550
+ The `disallowed_tools` field is respected when determining write capability — an agent with `tools: write` + `disallowed_tools: write` correctly gets read-only memory.
551
+
552
+ ## Worktree Isolation
553
+
554
+ Set `isolation: worktree` to run an agent in a temporary git worktree:
555
+
556
+ ```
557
+ Agent({ subagent_type: "refactor", prompt: "...", isolation: "worktree" })
558
+ ```
559
+
560
+ The agent gets a full, isolated copy of the repository. On completion:
561
+ - **No changes:** worktree is cleaned up automatically
562
+ - **Changes made:** changes are committed to a new branch (`pi-agent-<id>`) and returned in the result
563
+ - **Agent committed its own work:** the branch is created at the agent's HEAD, preserving its commits (uncommitted leftovers are committed on top first)
564
+
565
+ The automatic preservation commit uses `--no-verify`, so local pre-commit hooks can't block it — the commit is local-only and never pushed, and pre-push/server-side hooks still apply.
566
+
567
+ If the worktree cannot be created (not a git repo, no commits, or `git worktree add` fails), the `Agent` tool returns a clear error instead of running unisolated — `isolation: "worktree"` is a strict guarantee, not a hint. Initialize git and commit at least once, or omit `isolation`.
568
+
569
+ ## Skill Preloading
570
+
571
+ Skills can be preloaded by name and injected into the agent's system prompt:
572
+
573
+ ```yaml
574
+ ---
575
+ skills: api-conventions, error-handling
576
+ ---
577
+ ```
578
+
579
+ **Discovery roots** (checked in this order, first match wins):
580
+
581
+ | Scope | Path | Source |
582
+ |---|---|---|
583
+ | Project | `<cwd>/.pi/skills/` | Pi-standard |
584
+ | Project | `<cwd>/.agents/skills/` | [Agent Skills spec](https://agentskills.io/integrate-skills) |
585
+ | User | `$PI_CODING_AGENT_DIR/skills/` (default `~/.pi/agent/skills/`) | Pi-standard |
586
+ | User | `~/.agents/skills/` | [Agent Skills spec](https://agentskills.io/integrate-skills) |
587
+ | User | `~/.pi/skills/` | Legacy (pre-Pi) |
588
+
589
+ **Per root, a skill named `foo` resolves to the first of:**
590
+
591
+ - `<root>/foo.md` — flat file at the top level
592
+ - `<root>/foo/SKILL.md` — directory skill (top-level)
593
+ - `<root>/*/.../foo/SKILL.md` — directory skill, found by recursive descent
594
+
595
+ Recursion skips dotfile directories and `node_modules`. A directory that itself contains a `SKILL.md` is treated as a single skill — we don't descend into it. Traversal is byte-order sorted for deterministic resolution across filesystems.
596
+
597
+ **Security:** symlinks are rejected at every layer (root, flat file, skill directory, `SKILL.md` inside a skill directory) — intentional deviation from Pi, which follows symlinks. Skill names with path-traversal characters (`..`, `/`, `\`, spaces, leading dot, >128 chars) are rejected.
598
+
599
+ ## Tool Denylist
600
+
601
+ Block specific tools from an agent even if extensions provide them:
602
+
603
+ ```yaml
604
+ ---
605
+ tools: read, bash, grep, write
606
+ disallowed_tools: write, edit
607
+ ---
608
+ ```
609
+
610
+ This is useful for creating agents that inherit extension tools but should not have write access.
611
+
612
+ ## Architecture
613
+
614
+ ```
615
+ src/
616
+ index.ts # Extension entry: tool/command registration, rendering
617
+ types.ts # Type definitions (AgentConfig, AgentRecord, etc.)
618
+ default-agents.ts # Embedded default agent configs (general-purpose, Explore, Plan)
619
+ agent-types.ts # Unified agent registry (defaults + user), tool name resolution
620
+ agent-runner.ts # Session creation, execution, graceful max_turns, steer/resume
621
+ agent-manager.ts # Agent lifecycle, concurrency queue, completion notifications
622
+ cross-extension-rpc.ts # RPC handlers for cross-extension spawn/ping via pi.events
623
+ group-join.ts # Group join manager: batched completion notifications with timeout
624
+ custom-agents.ts # Load user-defined agents from .pi/agents/, .agents/agents/, and global agents
625
+ memory.ts # Persistent agent memory (resolve, read, build prompt blocks)
626
+ skill-loader.ts # Preload skills (Pi-standard + Agent Skills spec layouts)
627
+ output-file.ts # Streaming output file transcripts for agent sessions
628
+ worktree.ts # Git worktree isolation (create, cleanup, prune)
629
+ prompts.ts # Config-driven system prompt builder
630
+ context.ts # Parent conversation context for inherit_context
631
+ env.ts # Environment detection (git, platform)
632
+ ui/
633
+ agent-widget.ts # Persistent widget: spinners, activity, status icons, theming
634
+ conversation-viewer.ts # Live conversation overlay for viewing agent sessions
635
+ ```
636
+
637
+ ## License
638
+
639
+ MIT — [tintinweb](https://github.com/tintinweb)