@diousk/pi-subagents-fast 0.20.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.
Files changed (183) hide show
  1. package/CHANGELOG.md +808 -0
  2. package/CONTRIBUTING.md +72 -0
  3. package/LICENSE +21 -0
  4. package/README.md +1034 -0
  5. package/SECURITY.md +95 -0
  6. package/dist/abortable.d.ts +12 -0
  7. package/dist/abortable.js +42 -0
  8. package/dist/agent-color.d.ts +35 -0
  9. package/dist/agent-color.js +123 -0
  10. package/dist/agent-file-toggle.d.ts +125 -0
  11. package/dist/agent-file-toggle.js +260 -0
  12. package/dist/agent-manager.d.ts +472 -0
  13. package/dist/agent-manager.js +1338 -0
  14. package/dist/agent-runner.d.ts +312 -0
  15. package/dist/agent-runner.js +1034 -0
  16. package/dist/agent-types.d.ts +119 -0
  17. package/dist/agent-types.js +286 -0
  18. package/dist/child-context.d.ts +2 -0
  19. package/dist/child-context.js +12 -0
  20. package/dist/context.d.ts +12 -0
  21. package/dist/context.js +56 -0
  22. package/dist/cross-extension-rpc.d.ts +66 -0
  23. package/dist/cross-extension-rpc.js +138 -0
  24. package/dist/custom-agents.d.ts +54 -0
  25. package/dist/custom-agents.js +316 -0
  26. package/dist/default-agents.d.ts +7 -0
  27. package/dist/default-agents.js +122 -0
  28. package/dist/enabled-models.d.ts +49 -0
  29. package/dist/enabled-models.js +145 -0
  30. package/dist/env.d.ts +6 -0
  31. package/dist/env.js +28 -0
  32. package/dist/group-join.d.ts +32 -0
  33. package/dist/group-join.js +116 -0
  34. package/dist/index.d.ts +50 -0
  35. package/dist/index.js +3682 -0
  36. package/dist/invocation-config.d.ts +107 -0
  37. package/dist/invocation-config.js +83 -0
  38. package/dist/memory.d.ts +53 -0
  39. package/dist/memory.js +165 -0
  40. package/dist/mention-clone.d.ts +87 -0
  41. package/dist/mention-clone.js +153 -0
  42. package/dist/mention.d.ts +81 -0
  43. package/dist/mention.js +131 -0
  44. package/dist/model-resolver.d.ts +36 -0
  45. package/dist/model-resolver.js +95 -0
  46. package/dist/model-scope.d.ts +49 -0
  47. package/dist/model-scope.js +48 -0
  48. package/dist/nested-tools.d.ts +55 -0
  49. package/dist/nested-tools.js +299 -0
  50. package/dist/output-file.d.ts +43 -0
  51. package/dist/output-file.js +142 -0
  52. package/dist/prompts.d.ts +55 -0
  53. package/dist/prompts.js +91 -0
  54. package/dist/schedule-store.d.ts +38 -0
  55. package/dist/schedule-store.js +155 -0
  56. package/dist/schedule.d.ts +109 -0
  57. package/dist/schedule.js +359 -0
  58. package/dist/settings.d.ts +360 -0
  59. package/dist/settings.js +251 -0
  60. package/dist/skill-loader.d.ts +24 -0
  61. package/dist/skill-loader.js +93 -0
  62. package/dist/status-note.d.ts +61 -0
  63. package/dist/status-note.js +85 -0
  64. package/dist/structured-output.d.ts +61 -0
  65. package/dist/structured-output.js +112 -0
  66. package/dist/types.d.ts +371 -0
  67. package/dist/types.js +5 -0
  68. package/dist/ui/agent-mention.d.ts +82 -0
  69. package/dist/ui/agent-mention.js +187 -0
  70. package/dist/ui/agent-widget.d.ts +219 -0
  71. package/dist/ui/agent-widget.js +592 -0
  72. package/dist/ui/conversation-viewer.d.ts +120 -0
  73. package/dist/ui/conversation-viewer.js +578 -0
  74. package/dist/ui/fleet-list.d.ts +195 -0
  75. package/dist/ui/fleet-list.js +471 -0
  76. package/dist/ui/schedule-menu.d.ts +16 -0
  77. package/dist/ui/schedule-menu.js +94 -0
  78. package/dist/ui/select-item.d.ts +27 -0
  79. package/dist/ui/select-item.js +34 -0
  80. package/dist/ui/viewer-keys.d.ts +20 -0
  81. package/dist/ui/viewer-keys.js +17 -0
  82. package/dist/ui/workflow-card.d.ts +175 -0
  83. package/dist/ui/workflow-card.js +332 -0
  84. package/dist/ui/workflow-dialog.d.ts +305 -0
  85. package/dist/ui/workflow-dialog.js +843 -0
  86. package/dist/ui/workflow-menu.d.ts +60 -0
  87. package/dist/ui/workflow-menu.js +147 -0
  88. package/dist/usage.d.ts +135 -0
  89. package/dist/usage.js +120 -0
  90. package/dist/workflow/collisions.d.ts +95 -0
  91. package/dist/workflow/collisions.js +88 -0
  92. package/dist/workflow/entry.d.ts +32 -0
  93. package/dist/workflow/entry.js +29 -0
  94. package/dist/workflow/host.d.ts +62 -0
  95. package/dist/workflow/host.js +362 -0
  96. package/dist/workflow/journal.d.ts +97 -0
  97. package/dist/workflow/journal.js +120 -0
  98. package/dist/workflow/json-schema.d.ts +51 -0
  99. package/dist/workflow/json-schema.js +111 -0
  100. package/dist/workflow/meta.d.ts +67 -0
  101. package/dist/workflow/meta.js +317 -0
  102. package/dist/workflow/progress.d.ts +224 -0
  103. package/dist/workflow/progress.js +361 -0
  104. package/dist/workflow/runtime.d.ts +334 -0
  105. package/dist/workflow/runtime.js +830 -0
  106. package/dist/workflow/saved.d.ts +90 -0
  107. package/dist/workflow/saved.js +203 -0
  108. package/dist/workflow/task.d.ts +136 -0
  109. package/dist/workflow/task.js +207 -0
  110. package/dist/workflow/tool-description.d.ts +38 -0
  111. package/dist/workflow/tool-description.js +199 -0
  112. package/dist/workflow/worker-source.d.ts +47 -0
  113. package/dist/workflow/worker-source.js +778 -0
  114. package/dist/worktree.d.ts +52 -0
  115. package/dist/worktree.js +164 -0
  116. package/dist/xml.d.ts +10 -0
  117. package/dist/xml.js +12 -0
  118. package/docs/rpc.md +183 -0
  119. package/docs/workflows.md +437 -0
  120. package/examples/agent-tool-description.md +42 -0
  121. package/examples/workflows/compose.js +51 -0
  122. package/examples/workflows/fan-out-audit.js +47 -0
  123. package/examples/workflows/gated-fix.js +60 -0
  124. package/examples/workflows/lib/count-child.js +27 -0
  125. package/examples/workflows/review-panel.js +63 -0
  126. package/examples/workflows/structured-findings.js +78 -0
  127. package/package.json +68 -0
  128. package/src/abortable.ts +43 -0
  129. package/src/agent-color.ts +161 -0
  130. package/src/agent-file-toggle.ts +270 -0
  131. package/src/agent-manager.ts +1581 -0
  132. package/src/agent-runner.ts +1286 -0
  133. package/src/agent-types.ts +346 -0
  134. package/src/child-context.ts +15 -0
  135. package/src/context.ts +58 -0
  136. package/src/cross-extension-rpc.ts +198 -0
  137. package/src/custom-agents.ts +333 -0
  138. package/src/default-agents.ts +126 -0
  139. package/src/enabled-models.ts +180 -0
  140. package/src/env.ts +33 -0
  141. package/src/group-join.ts +141 -0
  142. package/src/index.ts +3991 -0
  143. package/src/invocation-config.ts +155 -0
  144. package/src/memory.ts +179 -0
  145. package/src/mention-clone.ts +196 -0
  146. package/src/mention.ts +141 -0
  147. package/src/model-resolver.ts +118 -0
  148. package/src/model-scope.ts +70 -0
  149. package/src/nested-tools.ts +422 -0
  150. package/src/output-file.ts +155 -0
  151. package/src/prompts.ts +142 -0
  152. package/src/schedule-store.ts +153 -0
  153. package/src/schedule.ts +386 -0
  154. package/src/settings.ts +587 -0
  155. package/src/skill-loader.ts +102 -0
  156. package/src/status-note.ts +90 -0
  157. package/src/structured-output.ts +130 -0
  158. package/src/types.ts +384 -0
  159. package/src/ui/agent-mention.ts +216 -0
  160. package/src/ui/agent-widget.ts +664 -0
  161. package/src/ui/conversation-viewer.ts +589 -0
  162. package/src/ui/fleet-list.ts +543 -0
  163. package/src/ui/schedule-menu.ts +105 -0
  164. package/src/ui/select-item.ts +45 -0
  165. package/src/ui/viewer-keys.ts +39 -0
  166. package/src/ui/workflow-card.ts +470 -0
  167. package/src/ui/workflow-dialog.ts +1115 -0
  168. package/src/ui/workflow-menu.ts +193 -0
  169. package/src/usage.ts +167 -0
  170. package/src/workflow/collisions.ts +123 -0
  171. package/src/workflow/entry.ts +47 -0
  172. package/src/workflow/host.ts +403 -0
  173. package/src/workflow/journal.ts +164 -0
  174. package/src/workflow/json-schema.ts +128 -0
  175. package/src/workflow/meta.ts +325 -0
  176. package/src/workflow/progress.ts +550 -0
  177. package/src/workflow/runtime.ts +1219 -0
  178. package/src/workflow/saved.ts +217 -0
  179. package/src/workflow/task.ts +302 -0
  180. package/src/workflow/tool-description.ts +200 -0
  181. package/src/workflow/worker-source.ts +781 -0
  182. package/src/worktree.ts +205 -0
  183. package/src/xml.ts +13 -0
@@ -0,0 +1,587 @@
1
+ // Persistence for pi-subagents operational settings.
2
+ // - Global: ~/.pi/agent/subagents.json (via getAgentDir()) — manual defaults, never written here
3
+ // - Project: <cwd>/.pi/subagents.json — written by /agents → Settings; overrides global on load
4
+
5
+ import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
6
+ import { dirname, join } from "node:path";
7
+ import { getAgentDir } from "@earendil-works/pi-coding-agent";
8
+ import { NO_FALLBACK } from "./agent-types.js";
9
+ import type { AgentMentionMode, JoinMode, ViewerMarkdownMode, WidgetMode } from "./types.js";
10
+
11
+ export interface SubagentsSettings {
12
+ maxConcurrent?: number;
13
+ /**
14
+ * Max concurrent FOREGROUND (blocking) agents — `0` = unlimited, the default,
15
+ * which preserves the behaviour that has always applied: nothing bounded
16
+ * foreground work, and pi dispatches a message's tool calls through
17
+ * `Promise.all`, so an unqualified fan-out of blocking `Agent` calls runs all
18
+ * at once. Set it to bound that (#253 — on local models, parallel agents
19
+ * thrash the prompt cache).
20
+ *
21
+ * Deliberately independent of `maxConcurrent` rather than folded into it: a
22
+ * foreground agent blocks the parent anyway, so charging it to the background
23
+ * pool would let a saturated pool starve the main session of work it could
24
+ * have done itself.
25
+ *
26
+ * Bounds only spawns a caller is blocking on inline. Nested children are
27
+ * exempt — their parent is blocked awaiting them, so queueing a child behind
28
+ * its own parent would deadlock — and so are detached spawns from
29
+ * cross-extension RPC or `@handle` mentions, which block nobody and are
30
+ * documented to start immediately. Foreground `resume` is also outside the
31
+ * pool: it reuses an existing session and never reaches the spawn path, so
32
+ * several blocking resumes in one message can still exceed the limit.
33
+ */
34
+ maxConcurrentForeground?: number;
35
+ /**
36
+ * 0 = unlimited — the extension's single source of truth for that convention:
37
+ * `normalizeMaxTurns()` in agent-runner.ts treats 0 → `undefined`, and the
38
+ * `/agents` → Settings input prompt explicitly says "0 = unlimited".
39
+ */
40
+ defaultMaxTurns?: number;
41
+ graceTurns?: number;
42
+ defaultJoinMode?: JoinMode;
43
+ /**
44
+ * Whether a top-level `Agent` spawn that doesn't say runs detached.
45
+ * Defaults to `true`, following Claude Code, where the agent backgrounds
46
+ * unless the caller passes `run_in_background: false`. Set `false` to restore
47
+ * the previous behaviour, where an unqualified spawn blocked the turn and
48
+ * returned its result inline.
49
+ *
50
+ * Top-level only. Nested spawns (a subagent spawning its own) always default
51
+ * to foreground regardless of this setting — see `nested-tools.ts`, where a
52
+ * detached child would be killed by `abortOwnedChildren` when its parent
53
+ * settles, with no notification path to deliver its result.
54
+ *
55
+ * An explicit `run_in_background` on the call, or in the agent file's
56
+ * frontmatter, overrides this in both directions; the setting only decides
57
+ * what "unspecified" means.
58
+ */
59
+ backgroundByDefault?: boolean;
60
+ /**
61
+ * Master switch for the schedule subagent feature. Defaults to `true`.
62
+ * When `false`: the `Agent` tool's `schedule` param + its guideline are
63
+ * stripped from the tool spec at registration (zero LLM-context cost), the
64
+ * scheduler doesn't bind to the session, and the `/agents → Scheduled jobs`
65
+ * menu entry is hidden. Schema-level removal applies at extension load
66
+ * (next pi session); runtime menu/runtime-fire short-circuit is immediate.
67
+ */
68
+ schedulingEnabled?: boolean;
69
+ /**
70
+ * When true, the effective model of each subagent spawn is validated
71
+ * against `enabledModels` from pi's settings — both global
72
+ * (`<agentDir>/settings.json`) and project-local (`<cwd>/.pi/settings.json`),
73
+ * with project overriding global (mirrors pi's SettingsManager deep-merge).
74
+ *
75
+ * scopeModels guards against runtime LLM choices, not user-level config.
76
+ * Out-of-scope handling reflects this:
77
+ * - Caller-supplied via `Agent({ model: "..." })` (only when frontmatter
78
+ * has no `model:`, since frontmatter is authoritative): hard error
79
+ * returned to the orchestrator, listing the allowed models. The LLM
80
+ * made an explicit out-of-scope choice and gets explicit feedback.
81
+ * - Frontmatter-pinned: warning toast + the pinned model runs. The
82
+ * agent's author/installer chose this; trust it.
83
+ * - Parent-inherited (neither caller nor frontmatter sets a model):
84
+ * warning toast + parent's model runs. The user chose the parent's
85
+ * model when starting the session; trust it.
86
+ *
87
+ * No-op when pi's `enabledModels` is empty or absent — nothing to validate
88
+ * against. Defaults to false: subagents may use any model.
89
+ */
90
+ scopeModels?: boolean;
91
+ /**
92
+ * When true, an unreadable or unparseable agent `.md` aborts extension load
93
+ * instead of being skipped with a warning — pi exits, naming the file.
94
+ *
95
+ * Startup only, by design. Mid-session reloads (one per `Agent` call) keep
96
+ * warning: a bad edit at 3pm should not kill the session on the next
97
+ * unrelated spawn, where the failure would look disconnected from its cause.
98
+ * For a checked-in `.pi/agents/`, failing at startup is the point — the
99
+ * alternative is running a *different* agent than the file names.
100
+ * Defaults to false.
101
+ */
102
+ strictAgentFiles?: boolean;
103
+ /**
104
+ * When true, the three built-in default agents (general-purpose, Explore, Plan)
105
+ * are not registered at startup. User-defined agents from project/global custom
106
+ * agent dirs are completely unaffected — only the hardcoded DEFAULT_AGENTS are suppressed.
107
+ * Defaults to false.
108
+ */
109
+ disableDefaultAgents?: boolean;
110
+ /**
111
+ * Which Agent tool description the LLM sees. "full" (default) is the rich
112
+ * Claude Code-style prompt; "compact" is a ~75% smaller version (one-line
113
+ * agent type list, terse usage notes) for small/local models where tool-spec
114
+ * tokens are expensive; "custom" reads `.pi/agent-tool-description.md`
115
+ * (project, falling back to `<agentDir>/agent-tool-description.md`) with
116
+ * `{{placeholder}}` substitution — a missing/empty file falls back to "full".
117
+ * The mode is read once at tool registration — changing it applies on the
118
+ * next pi session.
119
+ */
120
+ toolDescriptionMode?: ToolDescriptionMode;
121
+ /**
122
+ * Whether the Claude Code-style FleetView (the navigable main+subagents list
123
+ * rendered below the editor) is shown. Defaults to `true`. Pure-UI: when off,
124
+ * the list never registers and the global key handler never captures input.
125
+ */
126
+ fleetView?: boolean;
127
+ /**
128
+ * Whether `@handle message` typed at the prompt is routed to that subagent
129
+ * instead of the main model, and whether `@` offers running agents alongside
130
+ * pi's file completion. Defaults to `model`. Applied live.
131
+ *
132
+ * - `model`: mentioning an agent that is not running asks the main model to
133
+ * spawn it with the `Agent` tool, Claude Code's behaviour. Costs a turn,
134
+ * and the model writes the agent's prompt rather than your text being it.
135
+ * - `direct`: that agent is started here instead, with the typed message as
136
+ * its prompt and no main-model turn spent.
137
+ * - `off`: the input hook falls straight through and the stacked
138
+ * autocomplete provider delegates everything back to pi's built-in one.
139
+ *
140
+ * Messaging a running agent and resuming a finished one are direct in both
141
+ * `model` and `direct`. The legacy booleans are still accepted: `true` reads
142
+ * as `model`, `false` as `off`.
143
+ */
144
+ agentMentions?: AgentMentionMode;
145
+ /**
146
+ * Whether subagents persist their pi session by default, so `@handle` can
147
+ * reopen an agent's conversation long after its in-memory record is gone.
148
+ * Defaults to `true`. Per-agent `persist_session:` frontmatter overrides it
149
+ * in both directions. Turning it off restores the previous behaviour, where
150
+ * a handle stops resolving roughly ten minutes after the agent finishes and
151
+ * mentioning it starts a fresh run instead. Persisted sessions also appear
152
+ * nested under the spawning session in pi's `/resume`.
153
+ */
154
+ rememberAgents?: boolean;
155
+ /**
156
+ * Display mode for the persistent above-editor agent widget:
157
+ * - `all`: show every agent (foreground + background).
158
+ * - `background`: hide foreground agents — they already render inline as the
159
+ * Agent tool result, so the widget would otherwise double-render them
160
+ * (#118); everything else (background, queued, scheduled, RPC) stays.
161
+ * - `off`: hide the widget entirely.
162
+ * Defaults to `background`. Pure-UI and applied live (toggling refreshes the
163
+ * widget).
164
+ */
165
+ widgetMode?: WidgetMode;
166
+ /**
167
+ * Project/global default for writing each subagent's `.output` transcript
168
+ * (a JSON-lines copy of the run, stored under the OS temp dir).
169
+ * Defaults to `true`. Set `false` to make transcripts opt-in for the whole
170
+ * project (e.g. a repo that shouldn't leave run transcripts on disk for backup
171
+ * or DLP tooling to ingest). A custom agent's `output_transcript` frontmatter
172
+ * overrides this per agent. This governs only the transcript — it does NOT
173
+ * affect the persisted pi session (`persist_session`), worktree commits
174
+ * (`isolation: worktree`), or memory files.
175
+ */
176
+ outputTranscript?: boolean;
177
+ /**
178
+ * Whether `isolation: "worktree"` may create a worktree at all. Defaults to
179
+ * `true`. Set `false` on a repo where worktrees are too slow or too large to
180
+ * be worth it (#184): a requested worktree is then dropped and the agent runs
181
+ * in the main checkout.
182
+ *
183
+ * The drop is deliberately silent — there is no per-result note, because the
184
+ * setting exists for projects whose model asks for a worktree on every call,
185
+ * where a note would be noise on every result. What keeps the orchestrator
186
+ * from claiming a `pi-agent-*` branch anyway is that it is never told the
187
+ * capability exists: `isolationParam` (invocation-config.ts) drops the field
188
+ * from both tool schemas, and `isolationGuideline` (index.ts) drops the
189
+ * matching prose from the full and compact descriptions — a custom one opts
190
+ * in via the `{{isolationGuideline}}` placeholder. Anything that
191
+ * reintroduces the prose has to reintroduce a note with it.
192
+ *
193
+ * Deliberately a downgrade rather than an error. The fail-loud rule covers
194
+ * worktrees that *cannot* be created; this is the user declining one, and
195
+ * throwing would reject exactly the calls that the `isolation: "off"` value
196
+ * exists to tolerate. Enforced below the tool boundary, so it also covers the
197
+ * scheduler and the unvalidated cross-extension RPC path.
198
+ */
199
+ worktreeIsolation?: boolean;
200
+ /**
201
+ * Master switch for scripted workflows. Defaults to `true`.
202
+ *
203
+ * Off is not a soft hide: the `SubagentWorkflow` tool is never registered, so
204
+ * the model is not told it exists and cannot call it, the `/agents`
205
+ * Workflows entry is hidden, and `--subagents-workflow-file` is refused.
206
+ *
207
+ * Absent is not the same as `true`. Unset means *auto*: on, but yielding to
208
+ * another extension that already offers a workflow tool, because two
209
+ * orchestrators in one tool spec is a worse default than none — the model
210
+ * has to guess which to call, and pays for both descriptions to find out.
211
+ * Setting it explicitly pins the answer in both directions: `true` keeps
212
+ * ours whatever else is loaded, `false` is off regardless. See
213
+ * `resolveWorkflowCollisions` in index.ts.
214
+ *
215
+ * Read once at extension init, before registration, so flipping it in
216
+ * `/agents → Settings` takes effect on the next pi session — the same
217
+ * contract `schedulingEnabled` has, and for the same reason: a tool spec is
218
+ * fixed once pi has it.
219
+ */
220
+ workflowsEnabled?: boolean;
221
+ /**
222
+ * Hard ceiling on nested subagent delegation, counted from the main session:
223
+ * main = 0, its subagents = 1, their children = 2. Defaults to `2`; `0` or `1`
224
+ * disables nesting project-wide. Read when a subagent session is built, so a
225
+ * change applies to agents started after it.
226
+ */
227
+ maxSubagentDepth?: number;
228
+ /**
229
+ * Agent type substituted when a caller-supplied `subagent_type` doesn't
230
+ * resolve to exactly one enabled agent (unknown, disabled, or ambiguous by
231
+ * case). Omitted keeps the historical `general-purpose` fallback; a type name
232
+ * routes those calls to that agent instead; `"none"` disables the fallback so
233
+ * dispatch fails closed with an error naming the available types.
234
+ *
235
+ * The boolean `false` is accepted as a spelling of `"none"`, because a boolean
236
+ * would otherwise be dropped as the wrong type and silently leave the
237
+ * PERMISSIVE default in place while the author believes strict dispatch is on
238
+ * — the wrong direction to fail for this setting. Every other value is an
239
+ * agent name, so a mistaken `"off"` fails loudly at dispatch rather than
240
+ * meaning one thing here and another in the resolver.
241
+ */
242
+ fallbackSubagent?: string;
243
+ /**
244
+ * Whether this extension's tool results carry a `usage` field, so subagent
245
+ * spend reaches the parent session's own accounting. Defaults to `false`.
246
+ *
247
+ * Subagents run in their own pi sessions, so by default the parent's footer,
248
+ * statusline and `/cost` show only what the main model spent — a session that
249
+ * delegated most of its work reads as nearly free. Pi folds
250
+ * `toolResult.usage` into `getSessionStats()`, so attaching it makes those
251
+ * surfaces count subagents too, under `/cost`'s "Tools/summaries" bucket.
252
+ *
253
+ * Off by default because it changes numbers the user may already be tracking
254
+ * (a statusline reading session cost will step up), not because the numbers
255
+ * are wrong.
256
+ *
257
+ * Three properties of what gets reported:
258
+ * - Tokens exclude `cacheRead`, for the reason in `usage.ts` — the parent's
259
+ * token total therefore rises by billed tokens only.
260
+ * - Cost is pi's own per-message `usage.cost.total`; we price nothing, and
261
+ * a model pi has no rates for contributes 0.
262
+ * - The context-window percentage is untouched. Pi derives it from assistant
263
+ * messages alone (`getContextUsage`), so a delegating session's context
264
+ * does not appear to fill up faster.
265
+ */
266
+ reportUsage?: boolean;
267
+ /**
268
+ * Whether the subagent surfaces show an estimated dollar cost next to their
269
+ * token counts (widget, FleetView, conversation viewer, foreground results,
270
+ * completion notifications). Defaults to `false`. Applied live.
271
+ *
272
+ * Rendered as `~$0.0042` — the tilde marks it as pi's reported estimate
273
+ * rather than a billed figure, and it is omitted entirely when the model has
274
+ * no pricing data, so a local model shows tokens and no dollars.
275
+ *
276
+ * Independent of `reportUsage`: this one is what a human reads, that one is
277
+ * what the parent session counts.
278
+ */
279
+ showCost?: boolean;
280
+
281
+ /**
282
+ * Whether the widget's running rows name the model driving each agent and the
283
+ * thinking level it is running at.
284
+ *
285
+ * Off by default, unlike the tool result and the conversation viewer, which
286
+ * show the pair unconditionally: those have a line to themselves, while the
287
+ * widget row already carries the description, turns, tool uses, tokens and
288
+ * elapsed time, and every character it gains is one the description loses on a
289
+ * narrow terminal.
290
+ */
291
+ showModel?: boolean;
292
+ /**
293
+ * How much of the conversation viewer's transcript renders as Markdown.
294
+ * Defaults to `assistant`. Applied live — the viewer's `m` key cycles this
295
+ * same setting, so a choice made in the overlay persists like one made in
296
+ * `/agents → Settings`.
297
+ *
298
+ * Scoped rather than all-or-nothing because the two kinds of content have
299
+ * different contracts: assistant text is authored as Markdown, while a tool
300
+ * result is whatever bytes the tool produced. Rendering the latter as
301
+ * Markdown is lossy in ways that look like the tool misbehaved — see
302
+ * `ViewerMarkdownMode` for the specific rewrites — so `all` is opt-in.
303
+ */
304
+ viewerMarkdown?: ViewerMarkdownMode;
305
+ }
306
+
307
+ export type ToolDescriptionMode = "full" | "compact" | "custom";
308
+
309
+ /** Setter hooks used by applySettings to wire persisted values into in-memory state. */
310
+ export interface SettingsAppliers {
311
+ setMaxConcurrent: (n: number) => void;
312
+ setMaxConcurrentForeground: (n: number) => void;
313
+ setDefaultMaxTurns: (n: number) => void;
314
+ setGraceTurns: (n: number) => void;
315
+ setDefaultJoinMode: (mode: JoinMode) => void;
316
+ setBackgroundByDefault: (b: boolean) => void;
317
+ setSchedulingEnabled: (b: boolean) => void;
318
+ setScopeModels: (enabled: boolean) => void;
319
+ setStrictAgentFiles: (b: boolean) => void;
320
+ setDisableDefaultAgents: (b: boolean) => void;
321
+ setToolDescriptionMode: (mode: ToolDescriptionMode) => void;
322
+ setFleetView: (b: boolean) => void;
323
+ setAgentMentions: (mode: AgentMentionMode) => void;
324
+ setRememberAgents: (b: boolean) => void;
325
+ setWidgetMode: (mode: WidgetMode) => void;
326
+ setOutputTranscript: (b: boolean) => void;
327
+ setWorktreeIsolation: (b: boolean) => void;
328
+ setWorkflowsEnabled: (b: boolean) => void;
329
+ setMaxSubagentDepth: (n: number) => void;
330
+ setFallbackSubagent: (v: string | undefined) => void;
331
+ setReportUsage: (b: boolean) => void;
332
+ setShowCost: (b: boolean) => void;
333
+ setShowModel: (b: boolean) => void;
334
+ setViewerMarkdown: (mode: ViewerMarkdownMode) => void;
335
+ }
336
+
337
+ /** Emit callback — a subset of `pi.events.emit` to keep helpers testable. */
338
+ export type SettingsEmit = (event: string, payload: unknown) => void;
339
+
340
+ const VALID_JOIN_MODES: ReadonlySet<string> = new Set<JoinMode>(["async", "group", "smart"]);
341
+ const VALID_TOOL_DESCRIPTION_MODES: ReadonlySet<string> = new Set<ToolDescriptionMode>(["full", "compact", "custom"]);
342
+ const VALID_WIDGET_MODES: ReadonlySet<string> = new Set<WidgetMode>(["all", "background", "off"]);
343
+ const VALID_VIEWER_MARKDOWN_MODES: ReadonlySet<string> = new Set<ViewerMarkdownMode>(["off", "assistant", "all"]);
344
+ const VALID_AGENT_MENTION_MODES: ReadonlySet<string> = new Set<AgentMentionMode>(["model", "direct", "off"]);
345
+
346
+ // Sanity ceilings — prevent hand-edited configs from asking for values that
347
+ // make no operational sense (e.g. 1e6 concurrent subagents). Permissive enough
348
+ // that any realistic power-user setting passes through.
349
+ const MAX_CONCURRENT_CEILING = 1024;
350
+ const MAX_TURNS_CEILING = 10_000;
351
+ const GRACE_TURNS_CEILING = 1_000;
352
+ const SUBAGENT_DEPTH_CEILING = 16;
353
+
354
+ /** Drop fields that don't match the expected shape. Silent — garbage becomes absent. */
355
+ function sanitize(raw: unknown): SubagentsSettings {
356
+ if (!raw || typeof raw !== "object") return {};
357
+ const r = raw as Record<string, unknown>;
358
+ const out: SubagentsSettings = {};
359
+ if (
360
+ Number.isInteger(r.maxConcurrent) &&
361
+ (r.maxConcurrent as number) >= 1 &&
362
+ (r.maxConcurrent as number) <= MAX_CONCURRENT_CEILING
363
+ ) {
364
+ out.maxConcurrent = r.maxConcurrent as number;
365
+ }
366
+ // Floor 0, not 1 like maxConcurrent above: 0 is the documented "unlimited"
367
+ // value and the default, so dropping it would silently be unrepresentable.
368
+ if (
369
+ Number.isInteger(r.maxConcurrentForeground) &&
370
+ (r.maxConcurrentForeground as number) >= 0 &&
371
+ (r.maxConcurrentForeground as number) <= MAX_CONCURRENT_CEILING
372
+ ) {
373
+ out.maxConcurrentForeground = r.maxConcurrentForeground as number;
374
+ }
375
+ if (
376
+ Number.isInteger(r.defaultMaxTurns) &&
377
+ (r.defaultMaxTurns as number) >= 0 &&
378
+ (r.defaultMaxTurns as number) <= MAX_TURNS_CEILING
379
+ ) {
380
+ out.defaultMaxTurns = r.defaultMaxTurns as number;
381
+ }
382
+ if (
383
+ Number.isInteger(r.graceTurns) &&
384
+ (r.graceTurns as number) >= 1 &&
385
+ (r.graceTurns as number) <= GRACE_TURNS_CEILING
386
+ ) {
387
+ out.graceTurns = r.graceTurns as number;
388
+ }
389
+ if (
390
+ Number.isInteger(r.maxSubagentDepth) &&
391
+ (r.maxSubagentDepth as number) >= 0 &&
392
+ (r.maxSubagentDepth as number) <= SUBAGENT_DEPTH_CEILING
393
+ ) {
394
+ out.maxSubagentDepth = r.maxSubagentDepth as number;
395
+ }
396
+ if (typeof r.defaultJoinMode === "string" && VALID_JOIN_MODES.has(r.defaultJoinMode)) {
397
+ out.defaultJoinMode = r.defaultJoinMode as JoinMode;
398
+ }
399
+ if (typeof r.backgroundByDefault === "boolean") {
400
+ out.backgroundByDefault = r.backgroundByDefault;
401
+ }
402
+ if (typeof r.schedulingEnabled === "boolean") {
403
+ out.schedulingEnabled = r.schedulingEnabled;
404
+ }
405
+ if (typeof r.scopeModels === "boolean") {
406
+ out.scopeModels = r.scopeModels;
407
+ }
408
+ if (typeof r.strictAgentFiles === "boolean") {
409
+ out.strictAgentFiles = r.strictAgentFiles;
410
+ }
411
+ if (typeof r.disableDefaultAgents === "boolean") {
412
+ out.disableDefaultAgents = r.disableDefaultAgents;
413
+ }
414
+ if (typeof r.toolDescriptionMode === "string" && VALID_TOOL_DESCRIPTION_MODES.has(r.toolDescriptionMode)) {
415
+ out.toolDescriptionMode = r.toolDescriptionMode as ToolDescriptionMode;
416
+ }
417
+ if (typeof r.fleetView === "boolean") {
418
+ out.fleetView = r.fleetView;
419
+ }
420
+ // Was a boolean before the `model` mode existed. A hand-written or
421
+ // previously-written `true` means "on", which is now the default `model`.
422
+ if (typeof r.agentMentions === "boolean") {
423
+ out.agentMentions = r.agentMentions ? "model" : "off";
424
+ } else if (typeof r.agentMentions === "string" && VALID_AGENT_MENTION_MODES.has(r.agentMentions)) {
425
+ out.agentMentions = r.agentMentions as AgentMentionMode;
426
+ }
427
+ if (typeof r.rememberAgents === "boolean") {
428
+ out.rememberAgents = r.rememberAgents;
429
+ }
430
+ if (typeof r.widgetMode === "string" && VALID_WIDGET_MODES.has(r.widgetMode)) {
431
+ out.widgetMode = r.widgetMode as WidgetMode;
432
+ }
433
+ if (typeof r.outputTranscript === "boolean") {
434
+ out.outputTranscript = r.outputTranscript;
435
+ }
436
+ if (typeof r.worktreeIsolation === "boolean") {
437
+ out.worktreeIsolation = r.worktreeIsolation;
438
+ }
439
+ if (typeof r.reportUsage === "boolean") {
440
+ out.reportUsage = r.reportUsage;
441
+ }
442
+ if (typeof r.showCost === "boolean") {
443
+ out.showCost = r.showCost;
444
+ }
445
+ if (typeof r.showModel === "boolean") {
446
+ out.showModel = r.showModel;
447
+ }
448
+ if (typeof r.viewerMarkdown === "string" && VALID_VIEWER_MARKDOWN_MODES.has(r.viewerMarkdown)) {
449
+ out.viewerMarkdown = r.viewerMarkdown as ViewerMarkdownMode;
450
+ }
451
+ if (typeof r.workflowsEnabled === "boolean") {
452
+ out.workflowsEnabled = r.workflowsEnabled;
453
+ }
454
+ if (r.fallbackSubagent === false) {
455
+ // The only non-string spelling worth accepting: a boolean would otherwise be
456
+ // dropped, silently leaving the PERMISSIVE default in place. Every string is
457
+ // an agent name except the `none` sentinel, which the resolver recognizes —
458
+ // so a mistaken "off" fails loudly at dispatch instead of meaning something
459
+ // different here than it does there.
460
+ out.fallbackSubagent = NO_FALLBACK;
461
+ } else if (typeof r.fallbackSubagent === "string" && r.fallbackSubagent.trim()) {
462
+ out.fallbackSubagent = r.fallbackSubagent.trim();
463
+ }
464
+ return out;
465
+ }
466
+
467
+ function globalPath(): string {
468
+ return join(getAgentDir(), "subagents.json");
469
+ }
470
+
471
+ function projectPath(cwd: string): string {
472
+ return join(cwd, ".pi", "subagents.json");
473
+ }
474
+
475
+ /**
476
+ * Read a settings file. Missing file is silent (returns `{}`). A file that
477
+ * exists but can't be parsed emits a warning to stderr so users aren't
478
+ * silently reverted to defaults — and still returns `{}` so startup proceeds.
479
+ */
480
+ function readSettingsFile(path: string): SubagentsSettings {
481
+ if (!existsSync(path)) return {};
482
+ try {
483
+ return sanitize(JSON.parse(readFileSync(path, "utf-8")));
484
+ } catch (err) {
485
+ const reason = err instanceof Error ? err.message : String(err);
486
+ console.warn(`[pi-subagents] Ignoring malformed settings at ${path}: ${reason}`);
487
+ return {};
488
+ }
489
+ }
490
+
491
+ /** Load merged settings: global provides defaults, project overrides. */
492
+ export function loadSettings(cwd: string = process.cwd()): SubagentsSettings {
493
+ return { ...readSettingsFile(globalPath()), ...readSettingsFile(projectPath(cwd)) };
494
+ }
495
+
496
+ /**
497
+ * Write project-local settings. Global is never touched from code.
498
+ * Returns `true` on success, `false` if the write (or mkdir) failed so the
499
+ * caller can surface a warning — persistence isn't fatal but isn't silent.
500
+ */
501
+ export function saveSettings(s: SubagentsSettings, cwd: string = process.cwd()): boolean {
502
+ const path = projectPath(cwd);
503
+ try {
504
+ mkdirSync(dirname(path), { recursive: true });
505
+ writeFileSync(path, JSON.stringify(s, null, 2), "utf-8");
506
+ return true;
507
+ } catch {
508
+ return false;
509
+ }
510
+ }
511
+
512
+ /** Apply persisted settings to the in-memory state via caller-supplied setters. */
513
+ export function applySettings(s: SubagentsSettings, appliers: SettingsAppliers): void {
514
+ if (typeof s.maxConcurrent === "number") appliers.setMaxConcurrent(s.maxConcurrent);
515
+ if (typeof s.maxConcurrentForeground === "number") {
516
+ appliers.setMaxConcurrentForeground(s.maxConcurrentForeground);
517
+ }
518
+ if (typeof s.defaultMaxTurns === "number") appliers.setDefaultMaxTurns(s.defaultMaxTurns);
519
+ if (typeof s.graceTurns === "number") appliers.setGraceTurns(s.graceTurns);
520
+ if (typeof s.maxSubagentDepth === "number") appliers.setMaxSubagentDepth(s.maxSubagentDepth);
521
+ if (typeof s.fallbackSubagent === "string") appliers.setFallbackSubagent(s.fallbackSubagent);
522
+ if (s.defaultJoinMode) appliers.setDefaultJoinMode(s.defaultJoinMode);
523
+ if (typeof s.backgroundByDefault === "boolean") appliers.setBackgroundByDefault(s.backgroundByDefault);
524
+ if (typeof s.schedulingEnabled === "boolean") appliers.setSchedulingEnabled(s.schedulingEnabled);
525
+ if (typeof s.scopeModels === "boolean") appliers.setScopeModels(s.scopeModels);
526
+ if (typeof s.strictAgentFiles === "boolean") appliers.setStrictAgentFiles(s.strictAgentFiles);
527
+ if (typeof s.disableDefaultAgents === "boolean") appliers.setDisableDefaultAgents(s.disableDefaultAgents);
528
+ if (s.toolDescriptionMode) appliers.setToolDescriptionMode(s.toolDescriptionMode);
529
+ if (typeof s.fleetView === "boolean") appliers.setFleetView(s.fleetView);
530
+ if (s.agentMentions) appliers.setAgentMentions(s.agentMentions);
531
+ if (typeof s.rememberAgents === "boolean") appliers.setRememberAgents(s.rememberAgents);
532
+ if (s.widgetMode) appliers.setWidgetMode(s.widgetMode);
533
+ if (typeof s.outputTranscript === "boolean") appliers.setOutputTranscript(s.outputTranscript);
534
+ if (typeof s.worktreeIsolation === "boolean") appliers.setWorktreeIsolation(s.worktreeIsolation);
535
+ if (typeof s.reportUsage === "boolean") appliers.setReportUsage(s.reportUsage);
536
+ if (typeof s.showCost === "boolean") appliers.setShowCost(s.showCost);
537
+ if (typeof s.showModel === "boolean") appliers.setShowModel(s.showModel);
538
+ if (s.viewerMarkdown) appliers.setViewerMarkdown(s.viewerMarkdown);
539
+ if (typeof s.workflowsEnabled === "boolean") appliers.setWorkflowsEnabled(s.workflowsEnabled);
540
+ }
541
+
542
+ /**
543
+ * Format the user-facing toast for a settings mutation. Pure function —
544
+ * routes the success/failure of `saveSettings` into the right message + level
545
+ * so the UI layer (index.ts) stays a thin wire between input and notification.
546
+ */
547
+ export function persistToastFor(
548
+ successMsg: string,
549
+ persisted: boolean,
550
+ ): { message: string; level: "info" | "warning" } {
551
+ return persisted
552
+ ? { message: successMsg, level: "info" }
553
+ : { message: `${successMsg} (session only; failed to persist)`, level: "warning" };
554
+ }
555
+
556
+ /**
557
+ * Load merged settings, apply them to in-memory state, and emit the
558
+ * `subagents:settings_loaded` lifecycle event. Returns the loaded settings so
559
+ * callers can log/inspect. Extension init wires this once.
560
+ */
561
+ export function applyAndEmitLoaded(
562
+ appliers: SettingsAppliers,
563
+ emit: SettingsEmit,
564
+ cwd: string = process.cwd(),
565
+ ): SubagentsSettings {
566
+ const settings = loadSettings(cwd);
567
+ applySettings(settings, appliers);
568
+ emit("subagents:settings_loaded", { settings });
569
+ return settings;
570
+ }
571
+
572
+ /**
573
+ * Persist a settings snapshot, emit the `subagents:settings_changed` event
574
+ * (regardless of persist outcome so listeners see the in-memory change), and
575
+ * return the toast the UI should display. Event payload carries the `persisted`
576
+ * flag so listeners can react to write failures.
577
+ */
578
+ export function saveAndEmitChanged(
579
+ snapshot: SubagentsSettings,
580
+ successMsg: string,
581
+ emit: SettingsEmit,
582
+ cwd: string = process.cwd(),
583
+ ): { message: string; level: "info" | "warning" } {
584
+ const persisted = saveSettings(snapshot, cwd);
585
+ emit("subagents:settings_changed", { settings: snapshot, persisted });
586
+ return persistToastFor(successMsg, persisted);
587
+ }