@pi-unipi/unipi 3.0.0-alpha.2 → 3.0.0-alpha.21

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 (359) hide show
  1. package/CHANGELOG.md +292 -0
  2. package/README.md +8 -11
  3. package/docs/prefix-cache-architecture.md +14 -0
  4. package/package.json +22 -24
  5. package/packages/ask-user/README.md +55 -107
  6. package/packages/ask-user/ask-ui.ts +306 -732
  7. package/packages/ask-user/clipboard.ts +50 -0
  8. package/packages/ask-user/config.ts +74 -78
  9. package/packages/ask-user/package.json +2 -2
  10. package/packages/ask-user/questions.ts +151 -0
  11. package/packages/ask-user/skills/ask-user/SKILL.md +59 -133
  12. package/packages/ask-user/tools.ts +198 -432
  13. package/packages/autocomplete/package.json +1 -1
  14. package/packages/autocomplete/src/constants.ts +38 -43
  15. package/packages/autocomplete/src/sorting.ts +8 -0
  16. package/packages/background-tasks/package.json +2 -2
  17. package/packages/background-tasks/src/config.ts +0 -73
  18. package/packages/background-tasks/src/index.ts +20 -16
  19. package/packages/background-tasks/src/registry.ts +1 -171
  20. package/packages/background-tasks/src/types.ts +0 -32
  21. package/packages/btw/README.md +13 -56
  22. package/packages/btw/extensions/btw.ts +403 -1796
  23. package/packages/btw/package.json +5 -2
  24. package/packages/btw/skills/btw/SKILL.md +7 -143
  25. package/packages/compactor/README.md +56 -287
  26. package/packages/compactor/package.json +5 -9
  27. package/packages/compactor/skills/compactor/SKILL.md +13 -20
  28. package/packages/compactor/src/card.ts +90 -0
  29. package/packages/compactor/src/commands/index.ts +73 -130
  30. package/packages/compactor/src/compaction/compact-args.ts +5 -3
  31. package/packages/compactor/src/compaction/filter-noise.ts +1 -1
  32. package/packages/compactor/src/compaction/hooks.ts +487 -311
  33. package/packages/compactor/src/compaction/source.ts +178 -0
  34. package/packages/compactor/src/compaction/summarize.ts +586 -52
  35. package/packages/compactor/src/config/manager.ts +130 -127
  36. package/packages/compactor/src/config/schema.ts +32 -48
  37. package/packages/compactor/src/index.ts +40 -431
  38. package/packages/compactor/src/info-screen.ts +44 -190
  39. package/packages/compactor/src/session/recall-blocks.ts +1 -1
  40. package/packages/compactor/src/stats.ts +76 -0
  41. package/packages/compactor/src/tools/context-budget.ts +17 -34
  42. package/packages/compactor/src/tools/ctx-doctor.ts +45 -36
  43. package/packages/compactor/src/tools/register.ts +29 -269
  44. package/packages/compactor/src/types.ts +47 -186
  45. package/packages/core/README.md +25 -0
  46. package/packages/core/child-agent.ts +1 -0
  47. package/packages/core/command-echo.ts +63 -0
  48. package/packages/core/compaction-context.ts +41 -0
  49. package/packages/core/constants.ts +8 -38
  50. package/packages/core/events.ts +0 -53
  51. package/packages/core/fusion-status.ts +4 -0
  52. package/packages/core/global.d.ts +10 -0
  53. package/packages/core/harness-messages.ts +392 -0
  54. package/packages/core/index.ts +14 -0
  55. package/packages/core/kanboard-status.ts +49 -0
  56. package/packages/core/long-horizon-owner-status.ts +46 -0
  57. package/packages/core/model-cache.ts +81 -7
  58. package/packages/core/package.json +6 -3
  59. package/packages/core/src/attach/detect.ts +163 -0
  60. package/packages/core/src/child-agent/child-args.ts +31 -0
  61. package/packages/core/src/child-agent/delivery.ts +41 -0
  62. package/packages/core/src/child-agent/index.ts +5 -0
  63. package/packages/core/src/child-agent/readers.ts +203 -0
  64. package/packages/core/src/child-agent/runtime.ts +584 -0
  65. package/packages/core/src/evidence.ts +78 -0
  66. package/packages/core/src/hints/browser.ts +278 -0
  67. package/packages/core/src/hints/crab-data.ts +19 -0
  68. package/packages/core/src/hints/index.ts +865 -0
  69. package/packages/core/src/hints/lines.ts +607 -0
  70. package/packages/core/src/hints/store.ts +120 -0
  71. package/packages/core/src/jev/chatter.ts +24 -0
  72. package/packages/core/src/jev/settings.ts +177 -14
  73. package/packages/core/src/package-colors.ts +2 -0
  74. package/packages/core/src/settings/catalog.ts +39 -15
  75. package/packages/core/src/settings/engine.ts +48 -2
  76. package/packages/core/src/settings/hub.ts +83 -20
  77. package/packages/core/src/settings/open.ts +49 -0
  78. package/packages/core/src/settings/schema.ts +27 -7
  79. package/packages/core/src/tui/hub-kit.ts +18 -5
  80. package/packages/core/src/tui/kit.ts +198 -0
  81. package/packages/core/src/tui/progress.ts +73 -0
  82. package/packages/core/src/turn/arbiter.ts +290 -0
  83. package/packages/footer/README.md +4 -6
  84. package/packages/footer/package.json +3 -3
  85. package/packages/footer/src/glance-editor.ts +19 -11
  86. package/packages/footer/src/help.ts +1 -1
  87. package/packages/footer/src/index.ts +36 -3
  88. package/packages/footer/src/presets.ts +3 -4
  89. package/packages/footer/src/rendering/icons.ts +0 -20
  90. package/packages/footer/src/segments/compactor.ts +52 -142
  91. package/packages/footer/src/segments/status-ext.ts +0 -1
  92. package/packages/fusion/README.md +14 -4
  93. package/packages/fusion/package.json +4 -3
  94. package/packages/fusion/src/child-args.ts +1 -0
  95. package/packages/fusion/src/index.ts +161 -8
  96. package/packages/fusion/src/pi-settings.ts +57 -0
  97. package/packages/fusion/src/picker.ts +186 -51
  98. package/packages/fusion/src/preset.ts +56 -2
  99. package/packages/fusion/src/prompts.ts +1 -1
  100. package/packages/fusion/src/sidekick-runtime.ts +1 -420
  101. package/packages/fusion/src/tools.ts +107 -128
  102. package/packages/fusion/src/transcript.ts +27 -85
  103. package/packages/info-screen/package.json +2 -2
  104. package/packages/input-shortcuts/README.md +18 -30
  105. package/packages/input-shortcuts/package.json +2 -2
  106. package/packages/input-shortcuts/src/burst.ts +88 -0
  107. package/packages/input-shortcuts/src/chord-overlay.ts +20 -70
  108. package/packages/input-shortcuts/src/cleared-input.ts +97 -0
  109. package/packages/input-shortcuts/src/index.ts +99 -193
  110. package/packages/input-shortcuts/src/last-response.ts +40 -0
  111. package/packages/input-shortcuts/src/registers.ts +8 -23
  112. package/packages/input-shortcuts/src/types.ts +4 -16
  113. package/packages/input-shortcuts/src/undo-redo.ts +59 -47
  114. package/packages/kanboard/README.md +51 -47
  115. package/packages/kanboard/index.ts +293 -55
  116. package/packages/kanboard/package.json +8 -8
  117. package/packages/kanboard/skills/kanboard/SKILL.md +61 -27
  118. package/packages/kanboard/src/badges.ts +93 -0
  119. package/packages/kanboard/src/bin.ts +4 -2
  120. package/packages/kanboard/src/commands.ts +218 -84
  121. package/packages/kanboard/src/debug.ts +20 -0
  122. package/packages/kanboard/src/guard.ts +267 -109
  123. package/packages/kanboard/src/monitor.ts +330 -0
  124. package/packages/kanboard/src/notice-buffer.ts +74 -0
  125. package/packages/kanboard/src/progress.ts +27 -0
  126. package/packages/kanboard/src/reminders.ts +234 -0
  127. package/packages/kanboard/src/settings.ts +69 -15
  128. package/packages/kanboard/src/shapes.ts +5 -0
  129. package/packages/long-horizon/index.ts +190 -13
  130. package/packages/long-horizon/package.json +3 -3
  131. package/packages/long-horizon/src/commands.ts +103 -7
  132. package/packages/long-horizon/src/compaction-brief.ts +35 -0
  133. package/packages/long-horizon/src/engine/continuation.ts +84 -15
  134. package/packages/long-horizon/src/engine/goal-state.ts +64 -13
  135. package/packages/long-horizon/src/engine/nudge-stash.ts +71 -0
  136. package/packages/long-horizon/src/engine/ralph.ts +3 -2
  137. package/packages/long-horizon/src/engine/runaway.ts +68 -11
  138. package/packages/long-horizon/src/engine/verifier.ts +19 -0
  139. package/packages/long-horizon/src/gate.ts +37 -12
  140. package/packages/long-horizon/src/judge/resolve.ts +1 -0
  141. package/packages/long-horizon/src/owner.ts +35 -2
  142. package/packages/long-horizon/src/progress.ts +87 -0
  143. package/packages/long-horizon/src/prompts/goal.ts +1 -1
  144. package/packages/long-horizon/src/runtime.ts +172 -18
  145. package/packages/long-horizon/src/settings.ts +54 -39
  146. package/packages/long-horizon/src/tools/goal.ts +6 -0
  147. package/packages/long-horizon/src/tools/graph.ts +1 -1
  148. package/packages/long-horizon/src/tools/swarm.ts +3 -3
  149. package/packages/mcp/package.json +2 -2
  150. package/packages/memory/commands.ts +7 -2
  151. package/packages/memory/index.ts +210 -32
  152. package/packages/memory/package.json +3 -3
  153. package/packages/memory/save-session.ts +264 -0
  154. package/packages/memory/settings.ts +17 -0
  155. package/packages/memory/tools.ts +253 -203
  156. package/packages/notify/package.json +2 -2
  157. package/packages/skill-registry/README.md +53 -16
  158. package/packages/skill-registry/index.ts +230 -0
  159. package/packages/skill-registry/package.json +19 -8
  160. package/packages/skill-registry/src/editor.ts +206 -0
  161. package/packages/skill-registry/src/judge.ts +289 -0
  162. package/packages/skill-registry/src/registry.ts +87 -0
  163. package/packages/skill-registry/src/settings.ts +259 -0
  164. package/packages/skill-registry/src/vault.ts +80 -0
  165. package/packages/subagents/README.md +39 -119
  166. package/packages/subagents/package.json +6 -13
  167. package/packages/subagents/skills/subagents/SKILL.md +18 -42
  168. package/packages/subagents/src/agents.ts +213 -0
  169. package/packages/subagents/src/cards.ts +182 -0
  170. package/packages/subagents/src/index.ts +609 -1084
  171. package/packages/subagents/src/manager.ts +429 -0
  172. package/packages/subagents/src/profiles.ts +130 -0
  173. package/packages/subagents/src/transcript.ts +154 -0
  174. package/packages/subagents/src/ui.ts +389 -0
  175. package/packages/unipi/bundled.js +39756 -45569
  176. package/packages/unipi/index.ts +55 -10
  177. package/packages/updater/package.json +2 -2
  178. package/packages/utility/README.md +76 -69
  179. package/packages/utility/package.json +2 -2
  180. package/packages/utility/skills/image/SKILL.md +37 -0
  181. package/packages/utility/skills/utility/SKILL.md +17 -60
  182. package/packages/utility/src/answer/extract.ts +128 -0
  183. package/packages/utility/src/answer/index.ts +213 -0
  184. package/packages/utility/src/answer/reply.ts +133 -0
  185. package/packages/utility/src/answer/web.ts +167 -0
  186. package/packages/utility/src/attach/index.ts +205 -0
  187. package/packages/utility/src/commands.ts +38 -142
  188. package/packages/utility/src/diagnostics/engine.ts +50 -5
  189. package/packages/utility/src/image/index.ts +33 -0
  190. package/packages/utility/src/image/models.ts +221 -0
  191. package/packages/{image/src → utility/src/image}/recognize.ts +2 -2
  192. package/packages/utility/src/image/settings.ts +178 -0
  193. package/packages/{image/src/image-source.ts → utility/src/image/source.ts} +1 -1
  194. package/packages/utility/src/image/tools.ts +168 -0
  195. package/packages/utility/src/image/transports.ts +186 -0
  196. package/packages/utility/src/index.ts +68 -389
  197. package/packages/utility/src/lifecycle/cleanup.ts +116 -311
  198. package/packages/utility/src/rename/gate.ts +102 -0
  199. package/packages/utility/src/rename/index.ts +191 -0
  200. package/packages/utility/src/rename/session.ts +170 -0
  201. package/packages/utility/src/render/delegated.ts +285 -0
  202. package/packages/utility/src/render/harness.ts +683 -0
  203. package/packages/utility/src/render/parse.ts +156 -0
  204. package/packages/utility/src/render/pi-settings.ts +38 -0
  205. package/packages/utility/src/render/reply-bg.ts +307 -0
  206. package/packages/utility/src/render/simple.ts +724 -0
  207. package/packages/utility/src/render/spacing.ts +235 -0
  208. package/packages/utility/src/render/styled.ts +251 -0
  209. package/packages/utility/src/render/tools.ts +353 -0
  210. package/packages/utility/src/settings.ts +166 -233
  211. package/packages/utility/src/types.ts +1 -222
  212. package/packages/watchdog/index.ts +17 -6
  213. package/packages/watchdog/package.json +3 -3
  214. package/packages/watchdog/src/config.ts +3 -2
  215. package/packages/web-api/package.json +2 -2
  216. package/packages/workflow/README.md +3 -0
  217. package/packages/workflow/index.ts +0 -2
  218. package/packages/workflow/package.json +2 -2
  219. package/packages/workflow/src/permission/decide.ts +6 -4
  220. package/packages/workflow/src/permission/index.ts +17 -7
  221. package/packages/workflow/src/permission/settings.ts +39 -4
  222. package/packages/workflow/src/plan/index.ts +19 -4
  223. package/packages/background-tasks/extensions/delegate-child.ts +0 -1
  224. package/packages/background-tasks/src/context-parent-snapshot.ts +0 -142
  225. package/packages/background-tasks/src/context-token-budget.ts +0 -903
  226. package/packages/background-tasks/src/context-visible-conversation-v2.ts +0 -551
  227. package/packages/background-tasks/src/delegate/artifacts.ts +0 -487
  228. package/packages/background-tasks/src/delegate/budget.ts +0 -415
  229. package/packages/background-tasks/src/delegate/hook-contract-evidence.json +0 -18
  230. package/packages/background-tasks/src/delegate/hook-contract.ts +0 -154
  231. package/packages/background-tasks/src/delegate/launch.ts +0 -484
  232. package/packages/background-tasks/src/delegate/result-package.ts +0 -459
  233. package/packages/background-tasks/src/delegate/runner.ts +0 -430
  234. package/packages/background-tasks/src/delegate/seed.ts +0 -423
  235. package/packages/background-tasks/src/delegate/types.ts +0 -323
  236. package/packages/background-tasks/src/delegate-child-extension.ts +0 -978
  237. package/packages/background-tasks/src/delegate-extension.ts +0 -654
  238. package/packages/background-tasks/src/fixtures/delegate-context-incident.json +0 -17
  239. package/packages/compactor/skills/compactor-detail/SKILL.md +0 -116
  240. package/packages/compactor/skills/compactor-doctor/SKILL.md +0 -71
  241. package/packages/compactor/skills/compactor-stats/SKILL.md +0 -51
  242. package/packages/compactor/src/compaction/build-sections.ts +0 -76
  243. package/packages/compactor/src/compaction/extract/goals.ts +0 -36
  244. package/packages/compactor/src/compaction/extract/preferences.ts +0 -40
  245. package/packages/compactor/src/compaction/format.ts +0 -53
  246. package/packages/compactor/src/compaction/merge.ts +0 -143
  247. package/packages/compactor/src/config/presets.ts +0 -160
  248. package/packages/compactor/src/executor/executor.ts +0 -233
  249. package/packages/compactor/src/executor/runtime.ts +0 -115
  250. package/packages/compactor/src/security/evaluator.ts +0 -89
  251. package/packages/compactor/src/security/policy.ts +0 -96
  252. package/packages/compactor/src/security/scanner.ts +0 -65
  253. package/packages/compactor/src/session/auto-inject.ts +0 -60
  254. package/packages/compactor/src/session/db.ts +0 -325
  255. package/packages/compactor/src/session/extract.ts +0 -144
  256. package/packages/compactor/src/session/resume-inject.ts +0 -64
  257. package/packages/compactor/src/session/snapshot.ts +0 -327
  258. package/packages/compactor/src/tools/ctx-batch-execute.ts +0 -41
  259. package/packages/compactor/src/tools/ctx-execute-file.ts +0 -23
  260. package/packages/compactor/src/tools/ctx-execute.ts +0 -23
  261. package/packages/compactor/src/tools/ctx-stats.ts +0 -96
  262. package/packages/image/README.md +0 -99
  263. package/packages/image/package.json +0 -61
  264. package/packages/image/skills/image/SKILL.md +0 -76
  265. package/packages/image/src/generate.ts +0 -256
  266. package/packages/image/src/index.ts +0 -135
  267. package/packages/image/src/models.ts +0 -519
  268. package/packages/image/src/openai-images-api.ts +0 -282
  269. package/packages/image/src/register-providers.ts +0 -209
  270. package/packages/image/src/settings.ts +0 -173
  271. package/packages/image/src/tools.ts +0 -326
  272. package/packages/input-shortcuts/src/clipboard.ts +0 -119
  273. package/packages/kanboard/src/runner.ts +0 -817
  274. package/packages/skill-registry/skills/auto/SKILL.md +0 -465
  275. package/packages/skill-registry/skills/brainstorm/SKILL.md +0 -219
  276. package/packages/skill-registry/skills/chore-create/SKILL.md +0 -315
  277. package/packages/skill-registry/skills/chore-execute/SKILL.md +0 -314
  278. package/packages/skill-registry/skills/consolidate/SKILL.md +0 -142
  279. package/packages/skill-registry/skills/consultant/SKILL.md +0 -97
  280. package/packages/skill-registry/skills/debug/SKILL.md +0 -228
  281. package/packages/skill-registry/skills/document/SKILL.md +0 -120
  282. package/packages/skill-registry/skills/fix/SKILL.md +0 -212
  283. package/packages/skill-registry/skills/gather-context/SKILL.md +0 -145
  284. package/packages/skill-registry/skills/plan/SKILL.md +0 -231
  285. package/packages/skill-registry/skills/quick-fix/SKILL.md +0 -135
  286. package/packages/skill-registry/skills/quick-work/SKILL.md +0 -110
  287. package/packages/skill-registry/skills/research/SKILL.md +0 -251
  288. package/packages/skill-registry/skills/review-work/SKILL.md +0 -187
  289. package/packages/skill-registry/skills/scan-issues/SKILL.md +0 -195
  290. package/packages/skill-registry/skills/work/SKILL.md +0 -218
  291. package/packages/skill-registry/skills/worktree-create/SKILL.md +0 -69
  292. package/packages/skill-registry/skills/worktree-list/SKILL.md +0 -78
  293. package/packages/skill-registry/skills/worktree-merge/SKILL.md +0 -89
  294. package/packages/subagents/agents/delegate.md +0 -14
  295. package/packages/subagents/agents/oracle.md +0 -78
  296. package/packages/subagents/agents/researcher.md +0 -52
  297. package/packages/subagents/agents/reviewer.md +0 -80
  298. package/packages/subagents/agents/scout.md +0 -50
  299. package/packages/subagents/agents/worker.md +0 -59
  300. package/packages/subagents/prompts/council.md +0 -48
  301. package/packages/subagents/prompts/gather-context-and-clarify.md +0 -13
  302. package/packages/subagents/prompts/parallel-cleanup.md +0 -59
  303. package/packages/subagents/prompts/parallel-research.md +0 -50
  304. package/packages/subagents/prompts/parallel-review.md +0 -54
  305. package/packages/subagents/prompts/review-loop.md +0 -43
  306. package/packages/subagents/skills/council-mode/SKILL.md +0 -230
  307. package/packages/subagents/skills/subagents/references/constraints-and-recipes.md +0 -259
  308. package/packages/subagents/skills/subagents/references/execution-controls.md +0 -454
  309. package/packages/subagents/skills/subagents/references/management-authoring-rpc.md +0 -161
  310. package/packages/subagents/skills/subagents/references/multi-lane-orchestration.md +0 -39
  311. package/packages/subagents/skills/subagents/references/prompting-and-roles.md +0 -267
  312. package/packages/subagents/src/acceptance.ts +0 -331
  313. package/packages/subagents/src/agent-manager.ts +0 -405
  314. package/packages/subagents/src/agent-memory.ts +0 -300
  315. package/packages/subagents/src/agent-overrides.ts +0 -183
  316. package/packages/subagents/src/agent-runner.ts +0 -271
  317. package/packages/subagents/src/async-runner.ts +0 -422
  318. package/packages/subagents/src/authority-policy.ts +0 -47
  319. package/packages/subagents/src/budgets.ts +0 -285
  320. package/packages/subagents/src/child-safety.ts +0 -140
  321. package/packages/subagents/src/config.ts +0 -249
  322. package/packages/subagents/src/conversation-viewer.ts +0 -281
  323. package/packages/subagents/src/core-compat.ts +0 -94
  324. package/packages/subagents/src/custom-agents.ts +0 -343
  325. package/packages/subagents/src/file-system-retry.ts +0 -50
  326. package/packages/subagents/src/fleet-data.ts +0 -105
  327. package/packages/subagents/src/fleet-view.ts +0 -322
  328. package/packages/subagents/src/foreground-detach.ts +0 -59
  329. package/packages/subagents/src/fork-context.ts +0 -285
  330. package/packages/subagents/src/global.d.ts +0 -7
  331. package/packages/subagents/src/guide.ts +0 -129
  332. package/packages/subagents/src/mission-state.ts +0 -133
  333. package/packages/subagents/src/mission-store.ts +0 -436
  334. package/packages/subagents/src/output-limits.ts +0 -142
  335. package/packages/subagents/src/parity-types.ts +0 -315
  336. package/packages/subagents/src/pi-args.ts +0 -167
  337. package/packages/subagents/src/result-files.ts +0 -232
  338. package/packages/subagents/src/result-watcher.ts +0 -221
  339. package/packages/subagents/src/retained-children.ts +0 -176
  340. package/packages/subagents/src/run-fanout-budget.ts +0 -356
  341. package/packages/subagents/src/scheduled-runs.ts +0 -349
  342. package/packages/subagents/src/schemas.ts +0 -263
  343. package/packages/subagents/src/slash-commands.ts +0 -80
  344. package/packages/subagents/src/supervisor-channel.ts +0 -249
  345. package/packages/subagents/src/tool-handler.ts +0 -1144
  346. package/packages/subagents/src/types.ts +0 -238
  347. package/packages/subagents/src/widget.ts +0 -457
  348. package/packages/subagents/src/workflow-script.ts +0 -737
  349. package/packages/subagents/src/workflow-worker.ts +0 -384
  350. package/packages/subagents/src/worktree.ts +0 -614
  351. package/packages/utility/src/analytics/collector.ts +0 -293
  352. package/packages/utility/src/info-screen.ts +0 -80
  353. package/packages/utility/src/lifecycle/process.ts +0 -162
  354. package/packages/utility/src/prefix-cache.ts +0 -263
  355. package/packages/utility/src/skill-discovery.ts +0 -542
  356. package/packages/utility/src/tools/env.ts +0 -113
  357. package/packages/utility/src/tui/name-badge-state.ts +0 -315
  358. package/packages/utility/src/tui/name-badge.ts +0 -109
  359. /package/packages/{subagents/src → core/src/child-agent}/pi-spawn.ts +0 -0
@@ -0,0 +1,50 @@
1
+ /**
2
+ * @pi-unipi/ask-user — read an image from the system clipboard into a temp file
3
+ *
4
+ * pi's own clipboard reader is not exported, so Ctrl+V inside "Other" uses the
5
+ * usual tools: wl-paste (Wayland), xclip (X11), pngpaste (macOS). Returns the
6
+ * file path, or undefined when there is no image (or no clipboard — e.g. SSH).
7
+ */
8
+
9
+ import { spawnSync } from "node:child_process";
10
+ import { randomUUID } from "node:crypto";
11
+ import { writeFileSync } from "node:fs";
12
+ import { tmpdir } from "node:os";
13
+ import { join } from "node:path";
14
+
15
+ function run(cmd: string, args: string[]): Buffer | undefined {
16
+ try {
17
+ const r = spawnSync(cmd, args, { timeout: 3000, maxBuffer: 64 * 1024 * 1024 });
18
+ return r.status === 0 && r.stdout && r.stdout.length > 0 ? r.stdout : undefined;
19
+ } catch {
20
+ return undefined;
21
+ }
22
+ }
23
+
24
+ const TYPES = ["image/png", "image/jpeg", "image/webp", "image/gif"];
25
+ const EXT: Record<string, string> = { "image/png": ".png", "image/jpeg": ".jpg", "image/webp": ".webp", "image/gif": ".gif" };
26
+
27
+ export function readClipboardImageFile(env: NodeJS.ProcessEnv = process.env): string | undefined {
28
+ let data: Buffer | undefined;
29
+ let type = "image/png";
30
+ if (process.platform === "darwin") {
31
+ data = run("pngpaste", ["-"]);
32
+ } else {
33
+ const wayland = !!env.WAYLAND_DISPLAY;
34
+ const listed = wayland
35
+ ? run("wl-paste", ["--list-types"])?.toString()
36
+ : run("xclip", ["-selection", "clipboard", "-t", "TARGETS", "-o"])?.toString();
37
+ const found = TYPES.find((t) => listed?.split(/\s+/).includes(t));
38
+ if (!found) return undefined;
39
+ type = found;
40
+ data = wayland ? run("wl-paste", ["--type", found]) : run("xclip", ["-selection", "clipboard", "-t", found, "-o"]);
41
+ }
42
+ if (!data) return undefined;
43
+ const file = join(tmpdir(), `unipi-ask-${randomUUID()}${EXT[type] ?? ".png"}`);
44
+ try {
45
+ writeFileSync(file, data);
46
+ return file;
47
+ } catch {
48
+ return undefined;
49
+ }
50
+ }
@@ -1,55 +1,41 @@
1
1
  /**
2
- * @pi-unipi/ask-user — Config system
2
+ * @pi-unipi/ask-user — settings (namespace `ask-user`, /unipi:settings → Ask User)
3
3
  *
4
- * Reads/writes ask-user settings in ~/.pi/agent/settings.json
5
- * under the "unipi.askUser" key.
4
+ * enabled — give the agent the ask_user tool (OFF by default)
5
+ * notifyOnAsk — notification when the agent stops to ask
6
+ * escape — stop: Esc stops the agent's turn (Devin)
7
+ * send: Esc sends what's answered, the rest as skipped
8
+ * digitAdvance — a number key in a single-choice question also moves on
9
+ * helpLine — show "? Not ready to answer, help me out!"
10
+ * other — agent: the agent decides (on unless it sets other:false)
11
+ * always / never: override the agent
12
+ * maxQuestions — questions per call the agent may ask (1–4)
13
+ *
14
+ * Read fresh on every call, so changes in the hub apply to the next question.
6
15
  */
7
16
 
8
17
  import { getSettings, registerSettings, setSettings } from "@pi-unipi/core";
9
18
 
10
- /** Ask-user settings */
11
19
  export interface AskUserSettings {
12
- /** Whether the ask_user tool is enabled */
13
20
  enabled: boolean;
14
- /** Allowed question formats */
15
- allowedFormats: {
16
- /** Allow single-select questions */
17
- singleSelect: boolean;
18
- /** Allow multi-select questions */
19
- multiSelect: boolean;
20
- /** Allow freeform text input */
21
- freeform: boolean;
22
- };
23
- /** Send notification when agent pauses to ask a question */
24
21
  notifyOnAsk: boolean;
22
+ escape: "stop" | "send";
23
+ digitAdvance: boolean;
24
+ helpLine: boolean;
25
+ other: "agent" | "always" | "never";
26
+ maxQuestions: number;
25
27
  }
26
28
 
27
- /** Default settings */
28
29
  export const DEFAULT_SETTINGS: AskUserSettings = {
29
- enabled: true,
30
- allowedFormats: {
31
- singleSelect: true,
32
- multiSelect: true,
33
- freeform: true,
34
- },
30
+ enabled: false,
35
31
  notifyOnAsk: true,
32
+ escape: "stop",
33
+ digitAdvance: true,
34
+ helpLine: true,
35
+ other: "agent",
36
+ maxQuestions: 4,
36
37
  };
37
38
 
38
-
39
- let cachedSettings: AskUserSettings | null = null;
40
-
41
- /**
42
- * Check if value is a plain object.
43
- */
44
- function isRecord(value: unknown): value is Record<string, unknown> {
45
- return typeof value === "object" && value !== null && !Array.isArray(value);
46
- }
47
-
48
- /**
49
- * Get ask-user settings from settings.json.
50
- */
51
- // Registered with the unified settings hub. The engine's migration imports
52
- // the legacy ~/.pi/agent/settings.json unipi.askUser block once automatically.
53
39
  registerSettings({
54
40
  namespace: "ask-user",
55
41
  label: "Ask User",
@@ -58,58 +44,68 @@ registerSettings({
58
44
  {
59
45
  title: "Tool",
60
46
  fields: [
61
- { key: "enabled", type: "boolean", label: "Enable ask_user tool", description: "Allow the agent to ask structured questions" },
62
- { key: "notifyOnAsk", type: "boolean", label: "Notify on ask", description: "Send a notification when the agent pauses to ask" },
47
+ { key: "enabled", type: "boolean", label: "Enable ask_user", description: "Let the agent stop and ask you multiple-choice questions" },
48
+ { key: "notifyOnAsk", type: "boolean", label: "Notify when asked", description: "Send a notification when the agent is waiting for your answer" },
49
+ { key: "maxQuestions", type: "number", label: "Questions per call", min: 1, max: 4, description: "How many questions one dialog may hold (applies to new sessions)" },
63
50
  ],
64
51
  },
65
52
  {
66
- title: "Allowed formats",
53
+ title: "Dialog",
54
+ description: "How the question dialog behaves",
67
55
  fields: [
68
- { key: "allowedFormats.singleSelect", type: "boolean", label: "Single-select", description: "Questions with one correct answer" },
69
- { key: "allowedFormats.multiSelect", type: "boolean", label: "Multi-select", description: "Questions with several answers" },
70
- { key: "allowedFormats.freeform", type: "boolean", label: "Freeform", description: "Plain text input" },
56
+ {
57
+ key: "escape",
58
+ type: "enum",
59
+ label: "Esc",
60
+ options: [
61
+ { value: "stop", label: "stop the agent's turn" },
62
+ { value: "send", label: "send what's answered (rest skipped)" },
63
+ ],
64
+ description: "What Esc does in the dialog",
65
+ },
66
+ { key: "digitAdvance", type: "boolean", label: "Number keys move on", description: "In a single-choice question, picking with 1–9 also goes to the next question" },
67
+ {
68
+ key: "other",
69
+ type: "enum",
70
+ label: "\"Other\" choice",
71
+ options: [
72
+ { value: "agent", label: "agent decides (default on)" },
73
+ { value: "always", label: "always offer it" },
74
+ { value: "never", label: "never offer it" },
75
+ ],
76
+ description: "The free-text \"Other (type your own)\" row",
77
+ },
78
+ { key: "helpLine", type: "boolean", label: "\"Not ready\" line", description: "Show \"? Not ready to answer, help me out!\" under the dialog" },
71
79
  ],
72
80
  },
73
81
  ],
74
82
  });
75
83
 
76
- export function getAskUserSettings(): AskUserSettings {
77
- if (cachedSettings) return cachedSettings;
78
- const askUser = getSettings("ask-user", process.cwd()) as Record<string, unknown>;
79
- if (!isRecord(askUser)) {
80
- cachedSettings = { ...DEFAULT_SETTINGS };
81
- return cachedSettings;
82
- }
83
-
84
- const enabled = typeof askUser.enabled === "boolean" ? askUser.enabled : DEFAULT_SETTINGS.enabled;
84
+ function isRecord(value: unknown): value is Record<string, unknown> {
85
+ return typeof value === "object" && value !== null && !Array.isArray(value);
86
+ }
85
87
 
86
- let allowedFormats = DEFAULT_SETTINGS.allowedFormats;
87
- if (isRecord(askUser.allowedFormats)) {
88
- const fmt = askUser.allowedFormats;
89
- allowedFormats = {
90
- singleSelect: typeof fmt.singleSelect === "boolean" ? fmt.singleSelect : DEFAULT_SETTINGS.allowedFormats.singleSelect,
91
- multiSelect: typeof fmt.multiSelect === "boolean" ? fmt.multiSelect : DEFAULT_SETTINGS.allowedFormats.multiSelect,
92
- freeform: typeof fmt.freeform === "boolean" ? fmt.freeform : DEFAULT_SETTINGS.allowedFormats.freeform,
93
- };
88
+ export function getAskUserSettings(cwd: string = process.cwd()): AskUserSettings {
89
+ let raw: Record<string, unknown> = {};
90
+ try {
91
+ const s = getSettings("ask-user", cwd);
92
+ if (isRecord(s)) raw = s;
93
+ } catch {
94
+ // defaults
94
95
  }
95
-
96
- const notifyOnAsk = typeof askUser.notifyOnAsk === "boolean" ? askUser.notifyOnAsk : DEFAULT_SETTINGS.notifyOnAsk;
97
-
98
- cachedSettings = { enabled, allowedFormats, notifyOnAsk };
99
- return cachedSettings;
96
+ const bool = (v: unknown, d: boolean) => (typeof v === "boolean" ? v : d);
97
+ const max = typeof raw.maxQuestions === "number" ? Math.min(4, Math.max(1, Math.floor(raw.maxQuestions))) : DEFAULT_SETTINGS.maxQuestions;
98
+ return {
99
+ enabled: bool(raw.enabled, DEFAULT_SETTINGS.enabled),
100
+ notifyOnAsk: bool(raw.notifyOnAsk, DEFAULT_SETTINGS.notifyOnAsk),
101
+ escape: raw.escape === "send" ? "send" : "stop",
102
+ digitAdvance: bool(raw.digitAdvance, DEFAULT_SETTINGS.digitAdvance),
103
+ helpLine: bool(raw.helpLine, DEFAULT_SETTINGS.helpLine),
104
+ other: raw.other === "always" || raw.other === "never" ? raw.other : "agent",
105
+ maxQuestions: max,
106
+ };
100
107
  }
101
108
 
102
- /**
103
- * Save ask-user settings to settings.json.
104
- */
105
- export function saveAskUserSettings(settings: AskUserSettings): void {
106
- setSettings("ask-user", settings as unknown as Record<string, unknown>, "global", process.cwd());
107
- cachedSettings = settings;
109
+ export function saveAskUserSettings(settings: Partial<AskUserSettings>, cwd: string = process.cwd()): void {
110
+ setSettings("ask-user", settings as Record<string, unknown>, "global", cwd);
108
111
  }
109
-
110
- /**
111
- * Clear cached settings (for testing or reload).
112
- */
113
- export function clearSettingsCache(): void {
114
- cachedSettings = null;
115
- }
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pi-unipi/ask-user",
3
- "version": "3.0.0-alpha.2",
3
+ "version": "3.0.0-alpha.21",
4
4
  "description": "Structured user input tool for Pi coding agent — single-select, multi-select, freeform",
5
5
  "type": "module",
6
6
  "main": "index.ts",
@@ -40,7 +40,7 @@
40
40
  "access": "public"
41
41
  },
42
42
  "dependencies": {
43
- "@pi-unipi/core": "3.0.0-alpha.2"
43
+ "@pi-unipi/core": "3.0.0-alpha.21"
44
44
  },
45
45
  "peerDependencies": {
46
46
  "@earendil-works/pi-coding-agent": "^0.87.1",
@@ -0,0 +1,151 @@
1
+ /**
2
+ * @pi-unipi/ask-user — questions: schema shape, legacy conversion, answers (pure)
3
+ *
4
+ * One ask_user call carries 1–4 questions (Devin's ask shape):
5
+ * { questions: [{ question, header, options: [{ label, description }], multi_select }] }
6
+ * An "Other" free-text choice is always added unless a question sets
7
+ * other: false. Older single-question calls ({ question, context, options,
8
+ * allowMultiple, allowFreeform, timeout }) are converted by `prepareArgs`.
9
+ */
10
+
11
+ export const MAX_QUESTIONS = 4;
12
+ export const HEADER_MAX = 16;
13
+
14
+ export interface AskOption {
15
+ label: string;
16
+ description?: string;
17
+ /** Returned instead of the label when set. */
18
+ value?: string;
19
+ /** end_turn: stop the agent · new_session: hand off to `prefill`. */
20
+ action?: "end_turn" | "new_session";
21
+ prefill?: string;
22
+ }
23
+
24
+ export interface AskQuestion {
25
+ question: string;
26
+ header: string;
27
+ options: AskOption[];
28
+ multi_select?: boolean;
29
+ /** Offer "Other (type your own)" (default true). */
30
+ other?: boolean;
31
+ }
32
+
33
+ export interface AskParams {
34
+ questions: AskQuestion[];
35
+ }
36
+
37
+ /** What the user did with one question. */
38
+ export interface QuestionAnswer {
39
+ /** Chosen option values (single: at most one). */
40
+ selected: string[];
41
+ /** "Other" text (may contain [Image #N] tokens). */
42
+ custom_text?: string;
43
+ skipped: boolean;
44
+ }
45
+
46
+ function str(v: unknown): string {
47
+ return typeof v === "string" ? v : v === undefined || v === null ? "" : String(v);
48
+ }
49
+
50
+ /** A short chip label for a question that came without one. */
51
+ export function deriveHeader(question: string, index: number): string {
52
+ const words = question.replace(/[^\p{L}\p{N}\s-]/gu, " ").split(/\s+/).filter((w) => w.length > 2 && !/^(what|which|who|how|should|would|could|does|do|you|your|the|and|for|want|like|prefer)$/i.test(w));
53
+ const pick = words.slice(0, 2).map((w) => w[0]!.toUpperCase() + w.slice(1)).join(" ");
54
+ return (pick || `Question ${index + 1}`).slice(0, HEADER_MAX);
55
+ }
56
+
57
+ function normalizeOption(raw: unknown): AskOption | null {
58
+ if (typeof raw === "string") return raw.trim() ? { label: raw.trim() } : null;
59
+ if (!raw || typeof raw !== "object") return null;
60
+ const o = raw as Record<string, unknown>;
61
+ const label = str(o.label ?? o.value).trim();
62
+ if (!label) return null;
63
+ const out: AskOption = { label };
64
+ if (str(o.description).trim()) out.description = str(o.description).trim();
65
+ if (str(o.value).trim() && str(o.value).trim() !== label) out.value = str(o.value).trim();
66
+ if (o.action === "end_turn" || o.action === "new_session") out.action = o.action;
67
+ if (str(o.prefill).trim()) out.prefill = str(o.prefill).trim();
68
+ return out;
69
+ }
70
+
71
+ function normalizeQuestion(raw: Record<string, unknown>, index: number): AskQuestion | null {
72
+ const question = str(raw.question).trim();
73
+ if (!question) return null;
74
+ const options = (Array.isArray(raw.options) ? raw.options : []).map(normalizeOption).filter((o): o is AskOption => o !== null);
75
+ const header = (str(raw.header).trim() || deriveHeader(question, index)).slice(0, HEADER_MAX);
76
+ const multi = raw.multi_select ?? raw.multiSelect ?? raw.allowMultiple;
77
+ const other = raw.other ?? raw.allowFreeform;
78
+ return {
79
+ question,
80
+ header,
81
+ options,
82
+ ...(multi === true ? { multi_select: true } : {}),
83
+ ...(other === false && options.length > 0 ? { other: false } : {}),
84
+ };
85
+ }
86
+
87
+ /**
88
+ * Tool-call arguments → { questions }. Accepts the current shape and the
89
+ * legacy single-question one (context is folded into the question text;
90
+ * timeout is dropped — the user answers in their own time).
91
+ */
92
+ export function prepareArgs(args: unknown): AskParams {
93
+ const a = (args && typeof args === "object" ? args : {}) as Record<string, unknown>;
94
+ let raw: Record<string, unknown>[];
95
+ if (Array.isArray(a.questions)) raw = a.questions.filter((q): q is Record<string, unknown> => !!q && typeof q === "object");
96
+ else if (typeof a.question === "string") {
97
+ const context = str(a.context).trim();
98
+ raw = [{ ...a, header: str(a.header).trim() || deriveHeader(a.question, 0), question: context ? `${context}\n\n${a.question}` : a.question }];
99
+ } else raw = [];
100
+ const questions = raw.map(normalizeQuestion).filter((q): q is AskQuestion => q !== null).slice(0, MAX_QUESTIONS);
101
+ return { questions };
102
+ }
103
+
104
+ export function optionValue(o: AskOption): string {
105
+ return o.value ?? o.label;
106
+ }
107
+
108
+ export function isAnswered(a: QuestionAnswer | undefined): boolean {
109
+ return !!a && (a.selected.length > 0 || !!a.custom_text?.trim());
110
+ }
111
+
112
+ /** "Planet: Jupiter moon" — the one-line summary of an answer. */
113
+ export function answerSummary(q: AskQuestion, a: QuestionAnswer | undefined): string {
114
+ if (!isAnswered(a)) return "(skipped)";
115
+ const labels = a!.selected.map((v) => q.options.find((o) => optionValue(o) === v)?.label ?? v);
116
+ const parts = [...labels];
117
+ if (a!.custom_text?.trim()) parts.push(a!.custom_text.trim());
118
+ return parts.join(", ");
119
+ }
120
+
121
+ /**
122
+ * The tool result the agent reads. Mirrors Devin's:
123
+ * User answered your questions:
124
+ * { "<question>": { "selected": [...], "custom_text": "...", "skipped": false } }
125
+ */
126
+ export function answersText(questions: readonly AskQuestion[], answers: readonly (QuestionAnswer | undefined)[], images: readonly string[] = []): string {
127
+ const body: Record<string, QuestionAnswer> = {};
128
+ questions.forEach((q, i) => {
129
+ const a = answers[i];
130
+ const answered = isAnswered(a);
131
+ body[q.question] = {
132
+ selected: answered ? a!.selected : [],
133
+ ...(answered && a!.custom_text?.trim() ? { custom_text: a!.custom_text.trim() } : {}),
134
+ skipped: !answered,
135
+ };
136
+ });
137
+ const lines = [`User answered your questions:`, JSON.stringify(body, null, 2)];
138
+ if (images.length) lines.push(`Attached: ${images.join(", ")} (shown below).`);
139
+ if (questions.some((_, i) => !isAnswered(answers[i]))) lines.push("Skipped questions were left unanswered on purpose — don't ask them again unless you must.");
140
+ return lines.join("\n");
141
+ }
142
+
143
+ /** The "? help me out" result: nothing is decided, the user wants to talk first. */
144
+ export function clarifyText(questions: readonly AskQuestion[], answers: readonly (QuestionAnswer | undefined)[]): string {
145
+ return [
146
+ "The user is not ready to answer and wants to clarify these questions first.",
147
+ "They may have more information, context or questions for you. Start by asking what they would like to clarify, then reformulate the questions if needed.",
148
+ "Questions asked:",
149
+ ...questions.flatMap((q, i) => [`- "${q.question}"`, ` ${isAnswered(answers[i]) ? `Answer so far: ${answerSummary(q, answers[i])}` : "(No answer provided)"}`]),
150
+ ].join("\n");
151
+ }
@@ -1,164 +1,90 @@
1
1
  ---
2
2
  name: ask-user
3
3
  description: >
4
- Interactive decision-gating tool for structured user input.
5
- Use ask_user when you need user confirmation, preferences, or decisions
6
- before proceeding with high-impact or ambiguous choices.
4
+ Ask the user multiple-choice questions with the ask_user tool (1–4 questions
5
+ in one dialog, an "Other" free-text choice always included). Use when a
6
+ decision, preference or clarification needs the user before you continue.
7
7
  allowed-tools:
8
8
  - ask_user
9
9
  ---
10
10
 
11
11
  # Ask User
12
12
 
13
- Use the `ask_user` tool to collect structured input from the user.
13
+ `ask_user` shows one dialog with 1–4 questions and waits for the answers. If the tool call says it's turned off, ask in your reply — don't retry it.
14
14
 
15
- ## When to use ask_user
15
+ ## When to ask
16
16
 
17
- - Architectural trade-offs with high impact
18
- - Requirements are ambiguous or conflicting
19
- - Assumptions would materially change implementation
20
- - User preferences needed (style, approach, priority)
21
- - Confirming before destructive operations
17
+ - A choice with lasting impact (architecture, data model, naming, destructive steps)
18
+ - Requirements that are ambiguous or conflict
19
+ - A preference only the user can state
22
20
 
23
- ## Decision Handshake Flow
21
+ Ordinary engineering detail is not a reason to ask — decide and verify.
24
22
 
25
- 1. Gather evidence and summarize context
26
- 2. Ask ONE focused question via `ask_user`
27
- 3. Wait for explicit user choice
28
- 4. Confirm the decision, then proceed
23
+ ## How to ask
29
24
 
30
- ## Parameters
25
+ - **One call, every question you need now.** Never several `ask_user` calls at once.
26
+ - Each question: a full `question`, a short `header` (≤16 chars, shown as a chip), 2–4 `options` with a `label` (1–5 words) and a `description` (what it means or costs).
27
+ - Don't add an "Other" option — one is added automatically (`other: false` removes it when free text makes no sense).
28
+ - `multi_select: true` when several answers can apply.
31
29
 
32
- | Parameter | Type | Default | Description |
33
- |-----------|------|---------|-------------|
34
- | `question` | string | required | The question to ask |
35
- | `context` | string? | — | Additional context shown before question |
36
- | `options` | array? | [] | Multiple-choice options with labels, descriptions, values |
37
- | `allowMultiple` | boolean? | false | Enable multi-select |
38
- | `allowFreeform` | boolean? | true | Add "Custom response" checkable option |
39
- | `timeout` | number? | — | Auto-dismiss after N ms |
40
-
41
- ### Option Properties
42
-
43
- | Property | Type | Default | Description |
44
- |----------|------|---------|-------------|
45
- | `label` | string | required | Display label |
46
- | `description` | string? | — | Description shown below label |
47
- | `value` | string? | label | Value returned when selected |
48
- | `allowCustom` | boolean? | false | Allow user to add custom text for this option (shorthand for `action: "input"`) |
49
- | `action` | string? | "select" | Special action: `"select"`, `"input"`, `"end_turn"`, `"new_session"` |
50
- | `prefill` | string? | — | Prefill message for `"new_session"` action |
51
-
52
- ### Action Types
53
-
54
- | Action | Behavior |
55
- |--------|----------|
56
- | `"select"` | Normal selection (default). Returns immediately. |
57
- | `"input"` | Enters text input mode. Returns `combined` response with selection + text. |
58
- | `"end_turn"` | Signals end of agent turn. Returns `end_turn` response kind. |
59
- | `"new_session"` | Starts a handoff. Returns `new_session` response kind with optional `prefill`. Shows a launcher overlay offering **Compact & run** (compact first, then queue/submit the prefill) or **Run directly** (queue/submit immediately). The current LLM follow-up is aborted after a successful queue or editor fallback. |
60
-
61
- ## Examples
62
-
63
- Single choice:
64
- ```
30
+ ```ts
65
31
  ask_user({
66
- question: "Which database should we use?",
67
- options: [
68
- { label: "PostgreSQL", description: "Reliable, feature-rich" },
69
- { label: "SQLite", description: "Simple, serverless" }
70
- ]
71
- })
72
- ```
73
-
74
- Multi-select:
75
- ```
76
- ask_user({
77
- question: "Which features to implement?",
78
- options: [
79
- { label: "Auth", value: "auth" },
80
- { label: "Cache", value: "cache" },
81
- { label: "Logging", value: "logging" }
32
+ questions: [
33
+ {
34
+ header: "Database",
35
+ question: "Which database should the service use?",
36
+ options: [
37
+ { label: "Postgres", description: "JSON columns, full-text search, one more service to run" },
38
+ { label: "SQLite", description: "Zero setup; single writer" },
39
+ ],
40
+ },
41
+ {
42
+ header: "Features",
43
+ question: "Which features ship in v1?",
44
+ multi_select: true,
45
+ options: [
46
+ { label: "Search", description: "Full-text over notes" },
47
+ { label: "Sharing", description: "Read-only links" },
48
+ { label: "Export", description: "Markdown and JSON" },
49
+ ],
50
+ },
82
51
  ],
83
- allowMultiple: true
84
52
  })
85
53
  ```
86
54
 
87
- With context:
88
- ```
89
- ask_user({
90
- question: "Which approach?",
91
- context: "Current bottleneck: network I/O. Goal: reduce latency.",
92
- options: [
93
- { label: "Cache-first" },
94
- { label: "DB-first" }
95
- ]
96
- })
97
- ```
55
+ ## What comes back
98
56
 
99
- Freeform only:
100
57
  ```
101
- ask_user({
102
- question: "What should we name this module?",
103
- options: [],
104
- allowFreeform: true
105
- })
58
+ User answered your questions:
59
+ {
60
+ "Which database should the service use?": { "selected": ["Postgres"], "skipped": false },
61
+ "Which features ship in v1?": { "selected": ["Search"], "custom_text": "and tags", "skipped": false }
62
+ }
106
63
  ```
107
64
 
108
- Combined (multi-select + freeform):
109
- ```
110
- ask_user({
111
- question: "Which features and what custom feature?",
112
- options: [
113
- { label: "Auth", value: "auth" },
114
- { label: "Cache", value: "cache" }
115
- ],
116
- allowMultiple: true,
117
- allowFreeform: true
118
- })
119
- ```
120
- User can check "Auth", "Cache", and "Custom response" to type additional features.
65
+ - `custom_text` is what the user typed under "Other". It may reference attached files as `[Image #N]` (the image follows in the result) or `[File #N: /path]`.
66
+ - `skipped: true` — the user chose not to answer. Respect it; don't ask again unless you must.
67
+ - "Not ready to answer" — the user wants to talk first. Ask what they want to clarify; don't re-send the same questions.
68
+ - Cancelled — the user stopped the turn. Wait for their next message.
121
69
 
122
- With per-option custom text:
123
- ```
124
- ask_user({
125
- question: "Does this look right?",
126
- options: [
127
- { label: "Yes", value: "yes" },
128
- { label: "Partially", value: "partial", allowCustom: true },
129
- { label: "No", value: "no", allowCustom: true }
130
- ],
131
- allowFreeform: false
132
- })
133
- ```
134
- Selecting "Partially" or "No" enters text input so the user can explain what needs to change.
70
+ ## Workflow handoffs
135
71
 
136
- With end_turn and new_session actions:
137
- ```
72
+ An option can carry `action: "end_turn"` (picking it stops the turn) or `action: "new_session"` with a `prefill` (a message or `/command`). Picking a `new_session` option opens a launcher: **Compact & run** or **Run directly**.
73
+
74
+ ```ts
138
75
  ask_user({
139
- question: "How would you like to proceed?",
140
- options: [
141
- { label: "Looks good, proceed", value: "proceed" },
142
- { label: "I want changes", value: "changes", action: "input" },
143
- { label: "Done for now", value: "done", action: "end_turn" },
144
- { label: "Start fresh", value: "new", action: "new_session", prefill: "Let's redesign the..." }
145
- ],
146
- allowFreeform: false
76
+ questions: [{
77
+ header: "Next step",
78
+ question: "What would you like to do next?",
79
+ options: [
80
+ { label: "Implement the plan", description: "Start work in a fresh session", action: "new_session", prefill: "/unipi:work specs:2026-09-28-auth-plan" },
81
+ { label: "Done for now", description: "Return later", action: "end_turn" },
82
+ ],
83
+ other: false,
84
+ }],
147
85
  })
148
86
  ```
149
- - "Looks good" returns immediately with selection
150
- - "I want changes" enters text input mode for the user to explain
151
- - "Done for now" signals the agent to end its turn
152
- - "Start fresh" opens the launcher; **Compact & run** or **Run directly** queues the prefill message automatically
153
-
154
- ## Session Launcher
155
-
156
- When a user selects a `new_session` option, a secondary launcher overlay appears with three choices:
157
87
 
158
- | Choice | Behavior |
159
- |--------|----------|
160
- | 🧹 Compact & run | Starts `ctx.compact()` without waiting in the tool spinner, then queues/submits the prefill as a follow-up message after compaction or a short fallback timer |
161
- | ▶ Run directly | Queues/submits the prefill immediately as a follow-up message, without compaction |
162
- | ✕ Cancel | Cancels the session launch; no prefill is queued |
88
+ ## Without a UI
163
89
 
164
- The prefill can be a slash command (for example `the implementation step specs:...`) or any non-empty message. If automatic delivery fails, ask_user places the prefill in the editor and warns the user to press Enter. This two-step flow lets the user manage context window usage before starting a new task while avoiding unnecessary LLM follow-up in the old session.
90
+ In non-interactive runs, or when the tool is turned off, `ask_user` returns a notice instead of a dialog — ask in your reply. Inside a subagent it fails: put the question, the options and your recommendation in your report for the lead.