@tduyng/pi-shell 0.0.0-stage → 0.0.1

package/LICENSE

@@ -0,0 +1,178 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+Use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 tduyng

package/README.md

@@ -1,3 +1,67 @@
-# Temporary Holding Version
+# @tduyng/pi-shell
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Background shell execution for pi. One `bg` tool covers the full lifecycle: start, read output, kill, and list tasks.
+
+## The bg tool
+
+A single tool with an `action` field. Each `bg` task runs in the current working directory with a fresh shell, like pi's own bash. There is no persistent shell session.
+
+### start
+
+Spawns a detached command. Returns `task_id` (8-char UUID prefix), `pid`, and the absolute `log` path. stdout and stderr stream to a log file at `<agentDir>/shell-logs/<taskId>.log`. The task runs silently until you ask about it. Optional `timeout` caps the task (max 600 seconds). Default is no timeout.
+
+### output
+
+Reads new bytes since the last read using a byte cursor. The `wait` parameter controls behavior:
+
+- `"now"`: returns immediately with whatever is available.
+- `"next_write"`: parks the agent until the first new byte appears, then wakes it with the new output.
+- `"exit"`: parks the agent until the process ends, then delivers the verdict plus the unread tail.
+
+The cursor never advances on wake reads, so a later `bg` output call still sees every byte from the stored offset onward.
+
+### kill
+
+Sends SIGTERM to the process group, polls every 50ms for up to 1 second, then escalates to SIGKILL. Accepts `task_id`, raw `pid`, or `port` (resolved to a pid via `lsof -ti`).
+
+### status
+
+Lists all tasks with id, pid, state (running, exited, killed), cursor offset, and the first 80 characters of the command.
+
+## Honest exits
+
+Pi 0.99 already reports a signal-killed command as a failure. Its bash backend returns `128 + signal` for a child that died without an exit code, and raises when a command ends with neither an exit code nor a signal. This extension does not override that backend.
+
+`shell-process.test.ts` runs `kill -9` against pi's own bash tool and asserts a nonzero result in the 128+n family, so a pi release that reintroduces the silent success fails here.
+
+A `tool_result` handler annotates the two cases where the exit code alone cannot tell the model what happened. An exit 1 from `grep`, `rg`, or `find` means no matches, and a command killed by its timeout did not finish cleanly. Each note stops the model from retrying a search that already succeeded.
+
+## Middle-out output view
+
+Large logs are truncated to a head and tail, defaulting to 8KB total, with an exact omitted-byte count in between. The read window per side is 16KB, split on UTF-8 sequence boundaries so characters are never cut mid-byte. The full log stays on disk at the path always shown in results.
+
+## Wake on exit
+
+Only a task the model parked on (via `wait: "exit"` or `wait: "next_write"`) injects a user message when it finishes. A burst of exits coalesces into one message sharing a byte budget: default 8KB total, minimum 1KB per task. The wake carries the exit verdict, the unread tail, and the full log path per task, so the model gets the result without a read-back.
+
+The wake fires from the `onExit` callback via `queueMicrotask`, not from polling. If the agent is mid-turn, the wake lands in the follow-up queue and is delivered at the next `agent_settled` boundary.
+
+## Footer indicator
+
+The footer shows a dot and the live task count (e.g. "2 bg running") while any background task is active. It clears when the last task exits.
+
+## Task lifecycle
+
+Each `bg` task is in-memory only. It dies with the pi process. Persisted session entries record the command, log path, and start time so the model can read the log after a reload. The live process handle is gone. Detached grandchildren that inherit the shell's stdout keep writing to the log after the shell exits. The log stream stays open until both the stdout and stderr pipes close. Ending it on the first close would drop data the second pipe still delivers.
+
+## Install
+
+```bash
+pi install npm:@tduyng/pi-shell
+```
+
+Local checkout: `pi install /path/to/dotfiles/pi/agent/extensions/pi-shell`
+
+## Configure
+
+- `SHELL`: set to `0`, `false`, `no`, or `off` to disable the extension entirely.

package/package.json

@@ -1,6 +1,45 @@
 {
   "name": "@tduyng/pi-shell",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "description": "Background processes the agent parks on: one bg tool with start/output/kill/status, cursor reads that never re-read bytes, and a runtime wake-up when a task exits.",
+  "keywords": [
+    "pi",
+    "pi-package",
+    "pi-extension",
+    "pi-coding-agent",
+    "shell",
+    "background",
+    "process"
+  ],
+  "homepage": "https://gitlab.com/tduyng/pi-agent/-/tree/main/extensions/pi-shell#readme",
+  "bugs": "https://gitlab.com/tduyng/pi-agent/-/issues",
+  "license": "Apache-2.0",
+  "author": "tduyng",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/tduyng/pi-agent.git",
+    "directory": "extensions/pi-shell"
+  },
+  "type": "module",
+  "files": [
+    "src",
+    "!src/**/*.test.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "peerDependencies": {
+    "@earendil-works/pi-ai": "*",
+    "@earendil-works/pi-coding-agent": "*"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "pi": {
+    "extensions": [
+      "./src/index.ts"
+    ]
+  },
+  "dependencies": {
+    "ata-validator": "^1.62.1"
+  }
+}

package/src/index.ts

@@ -0,0 +1,385 @@
+import { Validator, type Infer } from 'ata-validator'
+import { t } from 'ata-validator/t'
+
+import {
+    isBashToolResult,
+    type AgentToolResult,
+    type ExtensionAPI,
+    type ExtensionContext
+} from '@earendil-works/pi-coding-agent'
+
+interface ToolResultPatch {
+    content: (import('@earendil-works/pi-ai').TextContent | import('@earendil-works/pi-ai').ImageContent)[]
+}
+
+import {
+    killTask,
+    middleOut,
+    benignExitNote,
+    pidForPort,
+    readNewBytes,
+    readUnreadTail,
+    registry,
+    spawnTask,
+    watchForWrite
+} from './process.js'
+import type { TaskRecord } from './process.js'
+const isString = new Validator(t.string()).isValidObject
+
+const OUTPUT_VIEW_MAX_BYTES = 8 * 1024
+const WAKE_TAIL_MAX_BYTES = 8 * 1024
+const MIN_WAKE_TAIL_BYTES = 1024
+
+const STATE_TYPE = 'shell'
+const WAKE_TYPE = 'shell-wake'
+const ENABLED = !/^(0|false|no|off)$/i.test(process.env['SHELL'] ?? '')
+const LOG_PREFIX = 'Full log: '
+
+const bgSchema = t.object({
+    action: t.string({ enum: ['start', 'output', 'kill', 'status'] }),
+    command: t.optional(t.string()),
+    timeout: t.optional(t.number()),
+    task_id: t.optional(t.string()),
+    from_offset: t.optional(t.number()),
+    wait: t.optional(t.union([t.literal('now'), t.literal('next_write'), t.literal('exit')])),
+    pid: t.optional(t.number()),
+    port: t.optional(t.number())
+})
+
+type BgInput = Infer<typeof bgSchema>
+
+function describeExit(exitCode: number | null, signal: string | null): string {
+    if (exitCode !== null) {
+        if (exitCode === 0) return 'exited 0'
+        return `exited ${exitCode}`
+    }
+    if (signal) {
+        const match = /^(SIG[A-Z]+)\s*\((.*)\)$/.exec(signal)
+        if (match) {
+            return `killed (${match[1]}, ${match[2]})`
+        }
+        if (signal.startsWith('SIGKILL')) return `killed (${signal})`
+        if (signal.startsWith('SIGTERM')) return `terminated (${signal})`
+        return `killed by ${signal}`
+    }
+    return 'exited (unknown status)'
+}
+
+function textResult(text: string): AgentToolResult<unknown> {
+    return { content: [{ type: 'text', text }], details: {} }
+}
+
+export function owedWakes(): TaskRecord[] {
+    return registry
+        .all()
+        .filter((rec) => rec.wakeRequested && !rec.wakeSent && (rec.exitCode !== null || rec.signal !== null))
+}
+
+export async function buildWakeText(records: TaskRecord[], budget = WAKE_TAIL_MAX_BYTES): Promise<string> {
+    const share = Math.max(MIN_WAKE_TAIL_BYTES, Math.floor(budget / records.length))
+    const blocks: string[] = []
+    for (const rec of records) {
+        const benign = isBenignNoMatch(rec) ? ' (no matches found, not an error)' : ''
+        const note = describeExit(rec.exitCode, rec.signal)
+        let tailText = ''
+        try {
+            const tail = await readUnreadTail(rec.taskId, share)
+            if (tail.text) {
+                const omitted = tail.end - tail.start - Buffer.byteLength(tail.text)
+                tailText = omitted > 0 ? `\n${tail.text}\n[${omitted} bytes omitted, middle cut]` : `\n${tail.text}`
+            }
+        } catch {}
+        blocks.push(`bg task ${rec.taskId} ${note}${benign}.${tailText}\n${LOG_PREFIX}${rec.logPath}`)
+    }
+    return blocks.join('\n\n')
+}
+
+export async function sendBackgroundWake(pi: Pick<ExtensionAPI, 'sendMessage'>, text: string): Promise<void> {
+    pi.sendMessage(
+        { customType: WAKE_TYPE, content: text, display: true },
+        { deliverAs: 'followUp', triggerTurn: true }
+    )
+}
+
+async function flushWakes(pi: ExtensionAPI): Promise<boolean> {
+    const owed = owedWakes()
+    if (owed.length === 0) return false
+    const text = await buildWakeText(owed)
+    try {
+        await sendBackgroundWake(pi, text)
+        for (const rec of owed) rec.wakeSent = true
+        return true
+    } catch {
+        return false
+    }
+}
+
+function isBenignNoMatch(rec: Pick<TaskRecord, 'command' | 'exitCode' | 'signal'>): boolean {
+    if (rec.exitCode !== 1 || rec.signal !== null) return false
+    const cmd = rec.command.trim()
+    return /^(grep|rg|find)\b/.test(cmd) || /\b(grep|rg)\b/.test(cmd)
+}
+
+interface PersistedTask {
+    taskId: string
+    command: string
+    logPath: string
+    startedAt: number
+}
+
+const StructuredResultSchema = t.object({ exit_code: t.optional(t.number()) }, { additionalProperties: true })
+const isStructuredResultSchema = new Validator(StructuredResultSchema).isValidObject
+
+const PersistedTaskSchema = t.object({
+    taskId: t.string({ minLength: 1 }),
+    command: t.string(),
+    logPath: t.string(),
+    startedAt: t.number()
+})
+const isPersistedTaskSchema = new Validator(PersistedTaskSchema).isValidObject
+
+function isPersistedTask(value: unknown): value is PersistedTask {
+    return isPersistedTaskSchema(value)
+}
+
+function reconstructTasks(ctx: ExtensionContext): void {
+    for (const entry of ctx.sessionManager.getBranch()) {
+        if (entry.type !== 'custom' || entry.customType !== STATE_TYPE) continue
+        if (!isPersistedTask(entry.data)) continue
+        const task = entry.data
+        if (registry.has(task.taskId)) continue
+        registry.set(task.taskId, {
+            taskId: task.taskId,
+            pid: 0,
+            command: task.command,
+            logPath: task.logPath,
+            offset: 0,
+            exitCode: null,
+            signal: 'session ended',
+            wakeRequested: false,
+            wakeSent: true,
+            startedAt: task.startedAt,
+            exitWaiters: new Set()
+        })
+    }
+}
+
+async function bgAction(pi: ExtensionAPI, ctx: ExtensionContext, params: BgInput): Promise<AgentToolResult<unknown>> {
+    const rec = params.task_id !== undefined ? registry.get(params.task_id) : undefined
+    if (params.action === 'output') {
+        if (!rec) throw new Error(`No such task: ${params.task_id}`)
+        const from = params.from_offset ?? rec.offset
+        const wait = params.wait ?? 'now'
+        const read = await readNewBytes(params.task_id!, from)
+        const view = middleOut(read.text, OUTPUT_VIEW_MAX_BYTES)
+        const omittedNote =
+            view.omitted > 0 ? `\n[${view.omitted} bytes omitted, middle cut. Full log: ${rec.logPath}]` : ''
+        const body = view.head + (view.omitted > 0 ? `\n...\n${view.tail}` : view.tail)
+
+        if (wait === 'exit' && (rec.exitCode !== null || rec.signal !== null)) {
+            rec.wakeSent = true
+            const benign = isBenignNoMatch(rec) ? ' (no matches found, not an error)' : ''
+            return textResult(
+                `task ${params.task_id} ${describeExit(rec.exitCode, rec.signal)}${benign}. ` +
+                    `bytes ${read.start}-${read.end} of ${read.size} since offset ${from}.\n` +
+                    `${body || '(no new output)'}${omittedNote}\n${LOG_PREFIX}${rec.logPath}`
+            )
+        }
+
+        if (wait === 'now') {
+            if (rec.exitCode !== null || rec.signal !== null) {
+                rec.wakeSent = true
+            }
+            return textResult(
+                `task ${params.task_id}: bytes ${read.start}-${read.end} of ${read.size}\n` +
+                    `${body || '(no new output)'}${omittedNote}\n${LOG_PREFIX}${rec.logPath}`
+            )
+        }
+
+        if (wait === 'next_write') {
+            const controller = watchForWrite(
+                params.task_id!,
+                read.end,
+                (text, start, end, size) => {
+                    const v = middleOut(text, OUTPUT_VIEW_MAX_BYTES)
+                    const omitted =
+                        v.omitted > 0 ? `\n[${v.omitted} bytes omitted, middle cut. Full log: ${rec.logPath}]` : ''
+                    void sendBackgroundWake(
+                        pi,
+                        `bg task ${params.task_id} wrote new output (bytes ${start}-${end} of ${size}).\n` +
+                            `${v.head}${v.omitted > 0 ? `\n...\n${v.tail}` : v.tail}${omitted}\n${LOG_PREFIX}${rec.logPath}`
+                    ).catch(() => undefined)
+                },
+                () => {
+                    if (rec.exitCode === null && rec.signal === null) return
+                    const benign = isBenignNoMatch(rec) ? ' (no matches found, not an error)' : ''
+                    void sendBackgroundWake(
+                        pi,
+                        `bg task ${params.task_id} exited ${describeExit(rec.exitCode, rec.signal)}${benign} with no new output. ${LOG_PREFIX}${rec.logPath}`
+                    ).catch(() => undefined)
+                }
+            )
+            ctx.signal?.addEventListener('abort', () => controller.abort(), { once: true })
+            return textResult(
+                `Watching task ${params.task_id} (bytes ${read.start}-${read.end} of ${read.size}). ` +
+                    `The agent will be woken when new output appears. ${LOG_PREFIX}${rec.logPath}`
+            )
+        }
+
+        rec.wakeRequested = true
+        return textResult(
+            `Watching task ${params.task_id} (bytes ${read.start}-${read.end} of ${read.size}). ` +
+                `The agent will be woken when it exits. ${LOG_PREFIX}${rec.logPath}`
+        )
+    }
+
+    if (params.action === 'kill') {
+        if (params.task_id !== undefined) {
+            const target = registry.get(params.task_id)
+            if (!target) throw new Error(`No such task: ${params.task_id}`)
+            if (target.exitCode !== null || target.signal !== null) {
+                return textResult(
+                    `Task ${params.task_id} already finished (${describeExit(target.exitCode, target.signal)}).`
+                )
+            }
+            target.wakeSent = true
+            killTask(params.task_id)
+            return textResult(`Sent SIGTERM to task ${params.task_id} (pid ${target.pid}).`)
+        }
+        if (params.pid !== undefined) {
+            const target = registry.all().find((r) => r.pid === params.pid)
+            if (!target) throw new Error(`pid ${params.pid} is not a background task of this session`)
+            if (target.exitCode !== null || target.signal !== null) {
+                return textResult(`pid ${params.pid} (task ${target.taskId}) already finished.`)
+            }
+            target.wakeSent = true
+            killTask(target.taskId)
+            return textResult(`Sent SIGTERM to pid ${params.pid} (task ${target.taskId}).`)
+        }
+        if (params.port !== undefined) {
+            const pid = await pidForPort(params.port)
+            if (pid === undefined) {
+                return textResult(`No process listening on port ${params.port}.`)
+            }
+            const target = registry.all().find((r) => r.pid === pid)
+            if (!target) throw new Error(`pid ${pid} on port ${params.port} is not a background task of this session`)
+            if (target.exitCode !== null || target.signal !== null) {
+                return textResult(`pid ${pid} on port ${params.port} (task ${target.taskId}) already finished.`)
+            }
+            target.wakeSent = true
+            killTask(target.taskId)
+            return textResult(`Sent SIGTERM to pid ${pid} on port ${params.port} (task ${target.taskId}).`)
+        }
+        throw new Error('bg action kill needs one of task_id, pid, or port')
+    }
+
+    const tasks = registry.all()
+    if (tasks.length === 0) {
+        return textResult('No background tasks.')
+    }
+    const lines = tasks.map((r) => {
+        const state = r.exitCode !== null || r.signal !== null ? describeExit(r.exitCode, r.signal) : 'running'
+        const benign = isBenignNoMatch(r) ? ' (no matches)' : ''
+        return `${r.taskId}  ${r.pid}  ${state}${benign}  offset ${r.offset}  ${r.command.slice(0, 80)}`
+    })
+    return textResult(lines.join('\n'))
+}
+
+let statusCtx: ExtensionContext | undefined
+
+function refreshBgStatus(): void {
+    if (!statusCtx) return
+    try {
+        const running = registry.all().filter((r) => r.exitCode === null && r.signal === null).length
+        statusCtx.ui.setStatus('shell', running > 0 ? `● ${running} bg running` : undefined)
+    } catch {
+        statusCtx = undefined
+    }
+}
+
+function agentIsIdle(): boolean {
+    if (!statusCtx) return false
+    try {
+        return statusCtx.isIdle() && !statusCtx.hasPendingMessages()
+    } catch {
+        statusCtx = undefined
+        return false
+    }
+}
+
+export default function shellExtension(pi: ExtensionAPI): void {
+    if (!ENABLED) return
+
+    pi.on('session_start', async (_event, ctx) => {
+        reconstructTasks(ctx)
+        statusCtx = ctx
+        refreshBgStatus()
+    })
+    pi.on('session_tree', async (_event, ctx) => {
+        reconstructTasks(ctx)
+        statusCtx = ctx
+        refreshBgStatus()
+    })
+
+    pi.registerTool({
+        name: 'bg',
+        label: 'bg',
+        description:
+            'Run background commands. start returns task_id, pid, and log path. output reads new bytes with wait now, next_write, or exit. kill stops by task_id, pid, or port. status lists tasks. Use for long commands.',
+        promptSnippet: 'Run background commands',
+        annotations: { readOnlyHint: false, destructiveHint: false, idempotentHint: false, openWorldHint: false },
+        promptGuidelines: [
+            'For long work, start it with bg, then request output with wait "exit" instead of polling a foreground shell.'
+        ],
+        parameters: bgSchema,
+        async execute(_toolCallId, params: BgInput, _signal, _onUpdate, ctx) {
+            if (params.action === 'start') {
+                if (!params.command) throw new Error('bg action start needs a command.')
+                statusCtx = ctx
+                const rec = spawnTask({
+                    command: params.command,
+                    cwd: ctx.cwd,
+                    timeout: params.timeout,
+                    onExit: () => {
+                        queueMicrotask(() => {
+                            refreshBgStatus()
+                            if (!agentIsIdle()) return
+                            void flushWakes(pi)
+                        })
+                    }
+                })
+                refreshBgStatus()
+                return textResult(
+                    `task_id: ${rec.taskId}\npid: ${rec.pid}\nlog: ${rec.logPath}\n` +
+                        `Started in background. Use bg (action output, wait "exit") to be woken when it finishes.`
+                )
+            }
+            return bgAction(pi, ctx, params)
+        }
+    })
+
+    pi.on('agent_settled', async (event, ctx) => {
+        statusCtx = ctx
+        refreshBgStatus()
+        if (event.aborted) return
+        if (!ctx.isIdle() || ctx.hasPendingMessages()) return
+        if (owedWakes().length === 0) return
+        queueMicrotask(() => {
+            void flushWakes(pi)
+        })
+    })
+
+    pi.on('tool_result', (event, _ctx): ToolResultPatch | undefined => {
+        if (!isBashToolResult(event)) return undefined
+        const resultText = event.content.map((c) => (c.type === 'text' ? c.text : '')).join('')
+        const rawCommand = event.input['command']
+        const command = isString(rawCommand) ? rawCommand : ''
+        const exitCode = isStructuredResultSchema(event.structuredContent)
+            ? event.structuredContent.exit_code
+            : undefined
+        const note = benignExitNote(event.isError, command, exitCode, resultText)
+
+        if (note === undefined) return undefined
+        return { content: [...event.content, { type: 'text' as const, text: note }] }
+    })
+}

package/src/process.ts

@@ -0,0 +1,508 @@
+import { spawn } from 'node:child_process'
+import type { ChildProcess } from 'node:child_process'
+import { randomUUID } from 'node:crypto'
+import { createWriteStream, mkdirSync, readdirSync, statSync, unlinkSync, watch } from 'node:fs'
+import type { WriteStream } from 'node:fs'
+import { open, stat } from 'node:fs/promises'
+import { basename, join } from 'node:path'
+
+import { getAgentDir, getShellConfig } from '@earendil-works/pi-coding-agent'
+
+export const DEFAULT_TIMEOUT_S = 0
+export const MAX_TIMEOUT_S = 600
+const SHELL_LOG_RETENTION_MS = 7 * 24 * 60 * 60 * 1000
+const MAX_SHELL_LOG_BYTES = 512 * 1024 * 1024
+const LOG_SWEEP_INTERVAL_MS = 5 * 60 * 1000
+let lastLogSweep = 0
+
+export interface TaskRecord {
+    taskId: string
+    pid: number
+    command: string
+    logPath: string
+    offset: number
+    exitCode: number | null
+    signal: string | null
+    wakeRequested: boolean
+    wakeSent: boolean
+    startedAt: number
+    child?: ChildProcess
+    exitWaiters: Set<() => void>
+}
+
+export interface SpawnOptions {
+    command: string
+    cwd: string
+    timeout?: number
+    onExit?: (taskId: string) => void
+}
+
+function timeoutSeconds(timeout: number | undefined): number {
+    if (timeout === undefined) return DEFAULT_TIMEOUT_S
+    if (!Number.isFinite(timeout) || timeout <= 0) {
+        throw new Error(`Invalid timeout: ${timeout}. Must be a positive number of seconds.`)
+    }
+    return Math.min(timeout, MAX_TIMEOUT_S)
+}
+export function killTree(pid: number): void {
+    try {
+        process.kill(process.platform === 'win32' ? pid : -pid, 'SIGKILL')
+    } catch {
+        try {
+            process.kill(pid, 'SIGKILL')
+        } catch {}
+    }
+}
+
+class ProcessRegistry {
+    private tasks = new Map<string, TaskRecord>()
+
+    has(taskId: string): boolean {
+        return this.tasks.has(taskId)
+    }
+
+    get(taskId: string): TaskRecord | undefined {
+        return this.tasks.get(taskId)
+    }
+
+    all(): TaskRecord[] {
+        return [...this.tasks.values()]
+    }
+
+    set(taskId: string, record: TaskRecord): void {
+        this.tasks.set(taskId, record)
+    }
+}
+
+export const registry = new ProcessRegistry()
+
+export function taskLogDir(): string {
+    return join(getAgentDir(), 'shell-logs')
+}
+
+function sweepTaskLogs(dir: string, now: number): void {
+    if (now - lastLogSweep < LOG_SWEEP_INTERVAL_MS) return
+    lastLogSweep = now
+    let entries: string[]
+    try {
+        entries = readdirSync(dir)
+    } catch {
+        return
+    }
+    const files = entries
+        .filter((name) => name.endsWith('.log'))
+        .map((name) => {
+            const path = join(dir, name)
+            try {
+                const fileStat = statSync(path)
+                return { name, path, size: fileStat.size, mtimeMs: fileStat.mtimeMs }
+            } catch {
+                return undefined
+            }
+        })
+        .filter((entry): entry is { name: string; path: string; size: number; mtimeMs: number } => entry !== undefined)
+        .toSorted((a, b) => a.mtimeMs - b.mtimeMs)
+    let total = files.reduce((sum, file) => sum + file.size, 0)
+    for (const file of files) {
+        if (registry.has(file.name.slice(0, -4))) continue
+        if (now - file.mtimeMs < SHELL_LOG_RETENTION_MS && total <= MAX_SHELL_LOG_BYTES) continue
+        try {
+            unlinkSync(file.path)
+            total -= file.size
+        } catch {}
+    }
+}
+
+interface ShellInvocation {
+    shell: string
+    args: string[]
+    fromStdin: boolean
+}
+
+function resolveShell(): ShellInvocation {
+    const cfg = getShellConfig()
+    return { shell: cfg.shell, args: cfg.args, fromStdin: cfg.commandTransport === 'stdin' }
+}
+
+export function spawnTask(options: SpawnOptions): TaskRecord {
+    const timeout = timeoutSeconds(options.timeout)
+    const taskId = randomUUID().slice(0, 8)
+    const logDirPath = taskLogDir()
+    mkdirSync(logDirPath, { recursive: true })
+    sweepTaskLogs(logDirPath, Date.now())
+    const logPath = join(logDirPath, `${taskId}.log`)
+    const stream: WriteStream = createWriteStream(logPath, { flags: 'a' })
+
+    const shell = resolveShell()
+    const child = spawn(shell.shell, shell.fromStdin ? shell.args : [...shell.args, options.command], {
+        cwd: options.cwd,
+        detached: process.platform !== 'win32',
+        stdio: shell.fromStdin ? ['pipe', 'pipe', 'pipe'] : ['ignore', 'pipe', 'pipe']
+    })
+    if (shell.fromStdin) {
+        child.stdin?.on('error', () => {})
+        child.stdin?.end(options.command)
+    }
+    child.stdout?.pipe(stream, { end: false })
+    child.stderr?.pipe(stream, { end: false })
+
+    const record: TaskRecord = {
+        taskId,
+        pid: child.pid ?? 0,
+        command: options.command,
+        logPath,
+        offset: 0,
+        exitCode: null,
+        signal: null,
+        wakeRequested: false,
+        wakeSent: false,
+        startedAt: Date.now(),
+        child,
+        exitWaiters: new Set()
+    }
+    registry.set(taskId, record)
+
+    let killTimer: NodeJS.Timeout | undefined
+    let finalized = false
+    const finalize = (): void => {
+        if (finalized) return
+        finalized = true
+        finalizeRecord(taskId, killTimer, options.onExit)
+    }
+    if (timeout > 0) {
+        killTimer = setTimeout(() => {
+            const rec = registry.get(taskId)
+            if (rec && rec.exitCode === null && rec.signal === null) {
+                killTree(rec.pid)
+                rec.signal = 'SIGKILL (timeout)'
+            }
+        }, timeout * 1000)
+    }
+
+    child.once('error', (err) => {
+        const rec = registry.get(taskId)
+        if (rec) {
+            rec.exitCode = 1
+            rec.signal = `spawn error: ${err.message}`
+            finalize()
+        }
+    })
+
+    child.once('exit', (code, signal) => {
+        const rec = registry.get(taskId)
+        if (rec) {
+            rec.exitCode = code
+            if (rec.signal === null) {
+                rec.signal = signal
+            }
+            finalize()
+        }
+    })
+
+    stream.on('error', () => {
+        const rec = registry.get(taskId)
+        if (!rec || finalized) return
+        killTree(rec.pid)
+        rec.exitCode = 1
+        rec.signal = 'log stream error'
+        finalize()
+    })
+
+    const pipes = [child.stdout, child.stderr].filter((pipe) => pipe !== undefined && pipe !== null)
+    let pipesClosed = 0
+    const onPipeClose = () => {
+        pipesClosed += 1
+        if (pipesClosed >= pipes.length) stream.end()
+    }
+    if (pipes.length === 0) {
+        stream.end()
+    } else {
+        for (const pipe of pipes) pipe.once('close', onPipeClose)
+    }
+
+    return record
+}
+
+function finalizeRecord(
+    taskId: string,
+    killTimer: NodeJS.Timeout | undefined,
+    onExit?: (taskId: string) => void
+): void {
+    const rec = registry.get(taskId)
+    if (rec) {
+        rec.child = undefined
+        rec.exitWaiters.forEach((w) => w())
+        rec.exitWaiters.clear()
+    }
+    if (killTimer) clearTimeout(killTimer)
+    onExit?.(taskId)
+}
+
+export function killTask(taskId: string): boolean {
+    const rec = registry.get(taskId)
+    if (!rec) return false
+    if (rec.exitCode !== null || rec.signal !== null) return true
+    const pid = rec.pid
+    if (!pid) return true
+    try {
+        process.kill(process.platform === 'win32' ? pid : -pid, 'SIGTERM')
+    } catch {
+        return true
+    }
+    const deadline = Date.now() + 1000
+    const poll = setInterval(() => {
+        const recNow = registry.get(taskId)
+        if (!recNow || recNow.exitCode !== null || recNow.signal !== null || Date.now() >= deadline) {
+            clearInterval(poll)
+            if (recNow && recNow.exitCode === null && recNow.signal === null) {
+                killTree(pid)
+            }
+        }
+    }, 50)
+    return true
+}
+
+export async function pidForPort(port: number): Promise<number | undefined> {
+    const { execFile } = await import('node:child_process')
+    const { promisify } = await import('node:util')
+    try {
+        const execFileP = promisify(execFile)
+        const out = await execFileP('lsof', ['-ti', `tcp:${port}`])
+        const stdout = String((out as { stdout?: unknown }).stdout ?? '')
+        const pid = stdout.trim().split('\n')[0]?.trim()
+        if (!pid) return undefined
+        const n = Number.parseInt(pid, 10)
+        return Number.isFinite(n) ? n : undefined
+    } catch {
+        return undefined
+    }
+}
+
+export async function readNewBytes(
+    taskId: string,
+    fromOffset: number
+): Promise<{
+    text: string
+    start: number
+    end: number
+    size: number
+    offset: number
+}> {
+    const rec = registry.get(taskId)
+    if (!rec) throw new Error(`No such task: ${taskId}`)
+    let file
+    try {
+        file = await open(rec.logPath, 'r')
+    } catch {
+        rec.offset = fromOffset
+        return { text: '', start: fromOffset, end: fromOffset, size: 0, offset: fromOffset }
+    }
+    try {
+        const size = (await file.stat()).size
+        const start = Math.max(0, Math.min(fromOffset, size))
+        if (start >= size) {
+            rec.offset = size
+            return { text: '', start, end: size, size, offset: size }
+        }
+        const unread = size - start
+        const VIEW_WINDOW = 16 * 1024
+        let text: string
+        if (unread <= VIEW_WINDOW * 2) {
+            const buffer = Buffer.alloc(unread)
+            const { bytesRead } = await file.read(buffer, 0, unread, start)
+            text = buffer.subarray(0, bytesRead).toString('utf8')
+        } else {
+            const headBuf = Buffer.alloc(VIEW_WINDOW)
+            const headRead = await file.read(headBuf, 0, VIEW_WINDOW, start)
+            const tailStart = size - VIEW_WINDOW
+            const tailBuf = Buffer.alloc(VIEW_WINDOW)
+            const tailRead = await file.read(tailBuf, 0, VIEW_WINDOW, tailStart)
+            const head = headBuf.subarray(0, headRead.bytesRead).toString('utf8')
+            const tail = tailBuf.subarray(0, tailRead.bytesRead).toString('utf8')
+            const omitted = size - start - headRead.bytesRead - tailRead.bytesRead
+            text = `${head}\n\n[${omitted} bytes omitted, middle cut]\n\n${tail}`
+        }
+        rec.offset = size
+        return { text, start, end: size, size, offset: rec.offset }
+    } finally {
+        await file.close()
+    }
+}
+
+export async function readUnreadTail(
+    taskId: string,
+    maxBytes = 8 * 1024
+): Promise<{ text: string; start: number; end: number; size: number }> {
+    const rec = registry.get(taskId)
+    if (!rec) throw new Error(`No such task: ${taskId}`)
+    const file = await open(rec.logPath, 'r')
+    try {
+        const size = (await file.stat()).size
+        const start = Math.min(rec.offset, size)
+        if (start >= size) {
+            return { text: '', start, end: size, size }
+        }
+        const unread = size - start
+        if (unread <= maxBytes) {
+            const buffer = Buffer.alloc(unread)
+            const { bytesRead } = await file.read(buffer, 0, buffer.length, start)
+            return { text: buffer.subarray(0, bytesRead).toString('utf8'), start, end: start + bytesRead, size }
+        }
+        const headLen = Math.floor(maxBytes / 2)
+        const tailLen = maxBytes - headLen
+        const headBuf = Buffer.alloc(headLen)
+        const tailBuf = Buffer.alloc(tailLen)
+        const headRead = await file.read(headBuf, 0, headLen, start)
+        const tailRead = await file.read(tailBuf, 0, tailLen, size - tailLen)
+        const head = headBuf.subarray(0, headRead.bytesRead).toString('utf8')
+        const tail = tailBuf.subarray(0, tailRead.bytesRead).toString('utf8')
+        return { text: `${head}\n...\n${tail}`, start, end: size, size }
+    } finally {
+        await file.close()
+    }
+}
+
+export function watchEventMatches(filename: string | Buffer | null, fileName: string): boolean {
+    return filename === null || filename.toString() === fileName
+}
+
+export function watchForWrite(
+    taskId: string,
+    fromOffset: number,
+    onWrite: (text: string, start: number, end: number, size: number) => void,
+    onExit: () => void
+): AbortController {
+    const rec = registry.get(taskId)
+    if (!rec) throw new Error(`No such task: ${taskId}`)
+    const controller = new AbortController()
+    const dir = taskLogDir()
+    const fileName = basename(rec.logPath)
+    let watcher: ReturnType<typeof watch> | undefined
+    let pollTimer: ReturnType<typeof setInterval> | undefined
+    let settled = false
+    let checking: Promise<boolean> | undefined
+
+    const stopPolling = () => {
+        if (pollTimer) clearInterval(pollTimer)
+        pollTimer = undefined
+    }
+    const stop = () => {
+        if (settled) return
+        settled = true
+        watcher?.close()
+        stopPolling()
+    }
+
+    const check = (): Promise<boolean> => {
+        if (checking) return checking
+        checking = (async (): Promise<boolean> => {
+            if (settled) return false
+            try {
+                const st = await stat(rec.logPath)
+                if (st.size <= fromOffset) return false
+                const { text, start, end, size } = await readNewBytes(taskId, fromOffset)
+                stop()
+                onWrite(text, start, end, size)
+                return true
+            } catch {
+                return false
+            }
+        })().finally(() => {
+            checking = undefined
+        })
+        return checking
+    }
+
+    const startPolling = (): void => {
+        if (pollTimer) return
+        pollTimer = setInterval(() => void check(), 250)
+        pollTimer.unref()
+    }
+
+    const finishWithoutOutput = async (wrote: boolean): Promise<void> => {
+        if (wrote || settled) return
+        stop()
+        try {
+            onExit()
+        } catch {}
+    }
+
+    if (rec.exitCode !== null || rec.signal !== null) {
+        void check().then(finishWithoutOutput)
+        return controller
+    }
+
+    const exitBridge = () => {
+        if (settled) return
+        void (checking ?? Promise.resolve(false))
+            .then(() => check())
+            .then(finishWithoutOutput)
+    }
+    rec.exitWaiters.add(exitBridge)
+
+    try {
+        watcher = watch(dir, (_event, filename) => {
+            if (watchEventMatches(filename, fileName)) void check()
+            if (filename === null) startPolling()
+        })
+    } catch {
+        startPolling()
+    }
+
+    void check()
+
+    controller.signal.addEventListener('abort', () => {
+        rec.exitWaiters.delete(exitBridge)
+        stop()
+    })
+    return controller
+}
+
+interface MiddleOutView {
+    head: string
+    tail: string
+    omitted: number
+    total: number
+}
+
+export function benignExitNote(
+    isError: boolean,
+    command: string,
+    exitCode: number | undefined,
+    raisedText: string
+): string | undefined {
+    if (!isError) return undefined
+    if (exitCode === 1 && /\b(?:grep|rg)\b/.test(command)) {
+        return '\n[Note: exit 1 here means no matches found, not an error.]'
+    }
+    if (exitCode === undefined && /^Command timed out after\b/.test(raisedText.trimEnd().split('\n').at(-1) ?? '')) {
+        return '\n[Note: the command timed out and was killed; not a clean exit.]'
+    }
+    return undefined
+}
+
+export function middleOut(text: string, maxBytes: number): MiddleOutView {
+    const total = Buffer.byteLength(text, 'utf8')
+    if (total <= maxBytes) {
+        return { head: text, tail: '', omitted: 0, total }
+    }
+    const half = Math.floor(maxBytes / 2)
+    const buf = Buffer.from(text, 'utf8')
+    let headEnd = half
+    let headByte = headEnd < buf.length ? buf[headEnd] : undefined
+    while (headEnd > 0 && headByte !== undefined && (headByte & 0xc0) === 0x80) {
+        headEnd--
+        headByte = headEnd < buf.length ? buf[headEnd] : undefined
+    }
+    const head = buf.subarray(0, headEnd).toString('utf8')
+    let tailStart = Math.max(headEnd, total - (maxBytes - headEnd))
+    let tailByte = tailStart < buf.length ? buf[tailStart] : undefined
+    while (tailByte !== undefined && (tailByte & 0xc0) === 0x80) {
+        tailStart++
+        tailByte = tailStart < buf.length ? buf[tailStart] : undefined
+    }
+    const tail = buf.subarray(tailStart).toString('utf8')
+    const headBytes = headEnd
+    const tailBytes = buf.length - tailStart
+    return { head, tail, omitted: total - headBytes - tailBytes, total }
+}