import * as fs from "node:fs"; import type { AgentTool, AgentToolContext, AgentToolResult, AgentToolUpdateCallback, ToolApprovalDecision, } from "@oh-my-pi/pi-agent-core"; import type { Component } from "@oh-my-pi/pi-tui"; import { ImageProtocol, TERMINAL } from "@oh-my-pi/pi-tui"; import { getProjectDir, isEnoent, logger, prompt } from "@oh-my-pi/pi-utils"; import { type } from "arktype"; import { type BashResult, executeBash } from "../exec/bash-executor"; import type { RenderResultOptions } from "../extensibility/custom-tools/types"; import { InternalUrlRouter } from "../internal-urls"; import { truncateToVisualLines } from "../modes/components/visual-truncate"; import { highlightCode, type Theme } from "../modes/theme/theme"; import bashDescription from "../prompts/tools/bash.md" with { type: "text" }; import type { ClientBridgeTerminalExitStatus, ClientBridgeTerminalOutput } from "../session/client-bridge"; import { DEFAULT_MAX_BYTES, enforceInlineByteCap, streamTailUpdates, TailBuffer } from "../session/streaming-output"; import { renderStatusLine } from "../tui"; import { CachedOutputBlock, markFramedBlockComponent } from "../tui/output-block"; import { getSixelLineMask } from "../utils/sixel"; import type { ToolSession } from "."; import { truncateForPrompt } from "./approval"; import { applyBashFixups } from "./bash-command-fixup"; import { type BashInteractiveResult, runInteractiveBashPty } from "./bash-interactive"; import { checkBashInterception } from "./bash-interceptor"; import { canUseInteractiveBashPty } from "./bash-pty-selection"; import { expandInternalUrls, type InternalUrlExpansionOptions } from "./bash-skill-urls"; import { invalidateGithubCacheForBashCommand } from "./gh-cache-invalidation"; import { formatStyledTruncationWarning, type OutputMeta, stripOutputNotice } from "./output-meta"; import { resolveToCwd } from "./path-utils"; import { capPreviewLines, formatToolWorkingDirectory, previewWindowRows, replaceTabs } from "./render-utils"; import { ToolAbortError, ToolError } from "./tool-errors"; import { toolResult } from "./tool-result"; import { clampTimeout, TOOL_TIMEOUTS } from "./tool-timeouts"; export const BASH_DEFAULT_PREVIEW_LINES = 10; const BASH_ENV_NAME_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*$/; const DEFAULT_AUTO_BACKGROUND_THRESHOLD_MS = 60_000; /** * Bash patterns flagged as safety critical for approval policy. * * Kept intentionally tight — the cost of a false negative is data loss or a compromised host, * while false positives remain actionable through user policy control. * New patterns should target shapes that are virtually never legitimate in automation. */ export const CRITICAL_BASH_PATTERNS = [ // Recursive destruction. /\brm\s+-[a-z]*[rRfF][a-z]*\s+\//i, // rm -rf /, rm -fr /, rm -r /, rm -f /… /\bsudo\s+rm\b/i, // any `sudo rm`. /\bchmod\s+-R\s+[0-7]+\s+\//i, // `chmod -R 777 /`. /\bchmod\s+-R\s+[ugoa+\-=rwxXst,]+\s+\//, // `chmod -R u+x /`, `chmod -R u+rwx,o+w /etc` (symbolic mode, root target). /\bchown\s+-R\s+\S+\s+\//i, // `chown -R user /`. // Fork bomb (a few common spacings). /:\(\)\s*\{\s*:\s*\|\s*:/i, // Disk / filesystem destruction. />\s*\/dev\/sd[a-z]/i, // write to disk device. /\bmkfs(\.|\b)/i, // format filesystem. /\bdd\s+if=.+of=\/dev\//i, // dd to a device. /\bshred\s+\/dev\//i, /\bcryptsetup\b/i, // System-config destruction. />\s*\/etc\/(?:passwd|shadow|sudoers)\b/i, /\btee\s+(?:-a\s+)?\/etc\/(?:passwd|shadow|sudoers)\b/i, // `tee /etc/passwd`, `tee -a /etc/sudoers`. // Remote-fetch-then-execute (curl/wget piped to a shell or process-subbed). /\b(?:curl|wget|fetch)\b[^|]*\|\s*(?:bash|sh|zsh|fish)\b/i, // Process-sub variants — `bash <(curl …)`, `source <(curl …)`, `. <(curl …)`. `.` and `source` are // anchored to a command boundary so `find . -name` and similar don't false-positive. /(?:^|[\s;&|(])(?:bash|sh|zsh|source|\.)\s+<\(\s*(?:curl|wget|fetch)\b/i, // `eval "$(curl …)"` / `eval $(curl …)` / `eval \`curl …\``. /\beval\s+["'`]?\$\(\s*(?:curl|wget|fetch)\b|\beval\s+`\s*(?:curl|wget|fetch)\b/i, // Process/host control. /\bkill\s+-9\s+1\b/, // kill PID 1. // Process/host control — must sit at command position so `npm run reboot-tests` // or `echo 'shutdown the queue'` don't false-positive. /(?:^|[\s;&|(])(?:shutdown|poweroff|reboot|halt)(?:\s|$|[;|&])/i, /(?:^|[\s;&|(])init\s+0\b/i, // Network-shell exfil. /\bnc\b[^|;]*\s-[a-zA-Z]*[ec][a-zA-Z]*\s/i, // `nc -e` / `nc -c`. ] as const; async function saveBashOriginalArtifact(session: ToolSession, originalText: string): Promise { try { const alloc = await session.allocateOutputArtifact?.("bash-original"); if (!alloc?.path || !alloc.id) return undefined; await Bun.write(alloc.path, originalText); return alloc.id; } catch { return undefined; } } const bashSchemaBase = type({ command: type("string").describe("command to execute"), "env?": type({ "[string]": "string" }).describe("extra env vars"), "timeout?": type("number").describe("timeout in seconds"), "cwd?": type("string").describe("working directory"), "pty?": type("boolean").describe("run in pty mode"), }); const bashSchemaWithAsync = type({ command: "string", "env?": { "[string]": "string" }, "timeout?": "number", "cwd?": "string", "pty?": "boolean", "async?": type("boolean").describe("run in background"), }); type BashToolSchema = typeof bashSchemaBase | typeof bashSchemaWithAsync; export interface BashToolInput { command: string; env?: Record; timeout?: number; cwd?: string; async?: boolean; pty?: boolean; } export interface BashToolDetails { meta?: OutputMeta; timeoutSeconds?: number; requestedTimeoutSeconds?: number; wallTimeMs?: number; /** Exit code of a command that ran to completion but failed (non-zero). */ exitCode?: number; terminalId?: string; async?: { state: "running" | "completed" | "failed"; jobId: string; type: "bash"; }; } export interface BashToolOptions {} type ManagedBashJobCompletion = | { kind: "completed"; result: AgentToolResult; } | { kind: "failed"; error: unknown; }; interface ManagedBashJobHandle { jobId: string; label: string; completion: Promise; getLatestText: () => string; setBackgrounded: (backgrounded: boolean) => void; } function normalizeResultOutput(result: BashResult | BashInteractiveResult): string { return result.output || ""; } function isInteractiveResult(result: BashResult | BashInteractiveResult): result is BashInteractiveResult { return "timedOut" in result; } function normalizeBashEnv(env: Record | undefined): Record | undefined { if (!env || Object.keys(env).length === 0) return undefined; const normalized: Record = {}; for (const [key, value] of Object.entries(env)) { if (!BASH_ENV_NAME_PATTERN.test(key)) { throw new ToolError(`Invalid bash env name: ${key}`); } normalized[key] = value; } return normalized; } function escapeBashEnvValueForDisplay(value: string): string { return value .replaceAll("\\", "\\\\") .replaceAll("\n", "\\n") .replaceAll("\r", "\\r") .replaceAll("\t", "\\t") .replaceAll('"', '\\"') .replaceAll("$", "\\$") .replaceAll("`", "\\`"); } function formatBashEnvAssignments(env: Record | undefined): string { if (!env || Object.keys(env).length === 0) return ""; return Object.entries(env) .sort(([a], [b]) => a.localeCompare(b)) .map(([key, value]) => `${key}="${escapeBashEnvValueForDisplay(value)}"`) .join(" "); } function unescapePartialJsonString(value: string): string { let output = ""; for (let index = 0; index < value.length; index += 1) { const char = value[index]; if (char !== "\\") { output += char; continue; } const next = value[index + 1]; if (!next) { output += "\\"; break; } index += 1; switch (next) { case '"': output += '"'; break; case "\\": output += "\\"; break; case "/": output += "/"; break; case "b": output += "\b"; break; case "f": output += "\f"; break; case "n": output += "\n"; break; case "r": output += "\r"; break; case "t": output += "\t"; break; case "u": { const hex = value.slice(index + 1, index + 5); if (/^[0-9a-fA-F]{4}$/u.test(hex)) { output += String.fromCharCode(Number.parseInt(hex, 16)); index += 4; } else { output += "\\u"; } break; } default: output += next; } } return output; } function extractPartialBashEnv(partialJson: string | undefined): Record | undefined { if (!partialJson) return undefined; const envStart = partialJson.search(/"env"\s*:\s*\{/u); if (envStart === -1) return undefined; const objectStart = partialJson.indexOf("{", envStart); if (objectStart === -1) return undefined; const envBody = partialJson.slice(objectStart + 1); const env: Record = {}; const matcher = /"([A-Za-z_][A-Za-z0-9_]*)"\s*:\s*"((?:\\.|[^"\\])*)(?:"|$)/gu; for (const match of envBody.matchAll(matcher)) { env[match[1]!] = unescapePartialJsonString(match[2]!); } return Object.keys(env).length > 0 ? env : undefined; } function formatTimeoutClampNotice(requestedTimeoutSec: number, effectiveTimeoutSec: number): string | undefined { return requestedTimeoutSec !== effectiveTimeoutSec ? `Timeout clamped to ${effectiveTimeoutSec}s (requested ${requestedTimeoutSec}s; allowed range ${TOOL_TIMEOUTS.bash.min}-${TOOL_TIMEOUTS.bash.max}s).` : undefined; } function formatWallTimeSeconds(wallTimeMs: number): string { return (wallTimeMs / 1000).toFixed(2); } function formatWallTimeNotice(wallTimeMs: number): string { return `Wall time: ${formatWallTimeSeconds(wallTimeMs)} seconds`; } function formatExitCodeNotice(exitCode: number): string { return `Command exited with code ${exitCode}`; } const RAW_OUTPUT_ARTIFACT_PREFIX = "[raw output: artifact://"; const RAW_OUTPUT_ARTIFACT_SUFFIX = "]"; function stripRawOutputArtifactNotice(text: string): { text: string; artifactId?: string } { const trimmed = text.trimEnd(); const lineStart = trimmed.lastIndexOf("\n"); const candidateStart = lineStart === -1 ? 0 : lineStart + 1; if ( !trimmed.startsWith(RAW_OUTPUT_ARTIFACT_PREFIX, candidateStart) || !trimmed.endsWith(RAW_OUTPUT_ARTIFACT_SUFFIX) ) { return { text }; } const idStart = candidateStart + RAW_OUTPUT_ARTIFACT_PREFIX.length; const idEnd = trimmed.length - RAW_OUTPUT_ARTIFACT_SUFFIX.length; if (idStart === idEnd) return { text }; for (let i = idStart; i < idEnd; i++) { const code = trimmed.charCodeAt(i); if (code < 48 || code > 57) return { text }; } const artifactId = trimmed.slice(idStart, idEnd); return { text: trimmed.slice(0, lineStart === -1 ? 0 : lineStart).trimEnd(), artifactId, }; } /** * Strip the trailing occurrence of `notice` (plus a single surrounding newline * on each side) so the TUI can echo the value via a styled footer label * instead of repeating it verbatim in the output pane. The notice is * reconstructed from the same value the result was tagged with, so a literal * sub-string match never strips a coincidental in-output token — only the * exact line we appended in #buildCompletedResult. */ function stripTrailingNotice(text: string, notice: string): string { const idx = text.lastIndexOf(notice); if (idx === -1) return text; let start = idx; let end = idx + notice.length; if (text[start - 1] === "\n") start -= 1; if (text[end] === "\n") end += 1; return (text.slice(0, start) + text.slice(end)).trimEnd(); } function stripWallTimeNotice(text: string, wallTimeMs: number | undefined): string { if (wallTimeMs === undefined) return text; return stripTrailingNotice(text, formatWallTimeNotice(wallTimeMs)); } function stripExitCodeNotice(text: string, exitCode: number | undefined): string { if (exitCode === undefined) return text; return stripTrailingNotice(text, formatExitCodeNotice(exitCode)); } /** * Bash tool implementation. * * Executes bash commands with optional timeout and working directory. */ export class BashTool implements AgentTool { readonly name = "bash"; readonly approval = (args: unknown): ToolApprovalDecision => { const rawCommand = (args as Partial).command; const command = typeof rawCommand === "string" ? rawCommand : ""; if (command !== "" && CRITICAL_BASH_PATTERNS.some(pattern => pattern.test(command))) { return { tier: "exec", override: true, reason: "Critical pattern detected" }; } return "exec"; }; readonly formatApprovalDetails = (args: unknown): string[] => { const rawCommand = (args as Partial).command; const command = typeof rawCommand === "string" ? rawCommand : "(missing)"; return [`Command: ${truncateForPrompt(command)}`]; }; readonly label = "Bash"; readonly loadMode = "essential"; readonly description: string; readonly parameters: BashToolSchema; // Non-pty calls run alongside each other (the executor isolates overlapping // runs on the same shell session); pty takes over the terminal UI and must // run alone. readonly concurrency = (args: Partial): "shared" | "exclusive" => args.pty === true ? "exclusive" : "shared"; readonly strict = true; readonly #asyncEnabled: boolean; readonly #autoBackgroundEnabled: boolean; readonly #autoBackgroundThresholdMs: number; constructor(private readonly session: ToolSession) { this.#asyncEnabled = this.session.settings.get("async.enabled"); this.#autoBackgroundEnabled = this.session.settings.get("bash.autoBackground.enabled"); this.#autoBackgroundThresholdMs = Math.max( 0, Math.floor( this.session.settings.get("bash.autoBackground.thresholdMs") ?? DEFAULT_AUTO_BACKGROUND_THRESHOLD_MS, ), ); this.parameters = this.#asyncEnabled ? bashSchemaWithAsync : bashSchemaBase; this.description = prompt.render(bashDescription, { asyncEnabled: this.#asyncEnabled, autoBackgroundEnabled: this.#autoBackgroundEnabled, autoBackgroundThresholdSeconds: Math.max(0, Math.floor(this.#autoBackgroundThresholdMs / 1000)), hasAstGrep: this.session.settings.get("astGrep.enabled"), hasAstEdit: this.session.settings.get("astEdit.enabled"), hasSearch: this.session.settings.get("search.enabled"), hasFind: this.session.settings.get("find.enabled"), }); } #formatResultOutput(result: BashResult | BashInteractiveResult): string { const outputText = normalizeResultOutput(result); return outputText || "(no output)"; } /** * Throw for outcomes that are *not* a completed command: user/timeout * aborts and a missing exit status. The foreground and bridge callers plus * the async job manager rely on these throwing so cancellations surface as * aborts and jobs are recorded as failed. A definite non-zero exit is a * completed command that failed; #buildCompletedResult surfaces it as an * error *result* (carrying execution details) rather than a throw. */ #throwIfUnfinished(result: BashResult | BashInteractiveResult, timeoutSec: number, outputText: string): void { if (result.cancelled) { // executeBash output already carries a `[Command cancelled]` notice from // the sink; PTY/bridge interactive output does not, so annotate it here. const out = normalizeResultOutput(result); const annotated = isInteractiveResult(result) && out ? `${out}\n\n[Command aborted]` : out; throw new ToolError(annotated || "Command aborted"); } if (isInteractiveResult(result) && result.timedOut) { const out = normalizeResultOutput(result); throw new ToolError( out ? `${out}\n\n[Command timed out after ${timeoutSec} seconds]` : `Command timed out after ${timeoutSec} seconds`, ); } if (result.exitCode === undefined) { throw new ToolError(`${outputText}\n\nCommand failed: missing exit status`); } } async #buildCompletedResult( result: BashResult | BashInteractiveResult, timeoutSec: number, options: { requestedTimeoutSec?: number; notices?: readonly string[]; terminalId?: string; wallTimeMs?: number; } = {}, ): Promise> { const exitCode = result.exitCode; const failedExit = exitCode !== undefined && exitCode !== 0; const outputLines = [this.#formatResultOutput(result)]; const notices: string[] = []; if (options.wallTimeMs !== undefined) { notices.push(formatWallTimeNotice(options.wallTimeMs)); } if (options.notices) { for (const notice of options.notices) { if (notice) notices.push(notice); } } if (notices.length > 0) outputLines.push("", ...notices); if (failedExit) outputLines.push("", formatExitCodeNotice(exitCode)); const outputText = outputLines.join("\n"); // Aborts / timeouts / missing-status still propagate as thrown errors. this.#throwIfUnfinished(result, timeoutSec, outputText); const details: BashToolDetails = { timeoutSeconds: timeoutSec }; if (options.requestedTimeoutSec !== undefined && options.requestedTimeoutSec !== timeoutSec) { details.requestedTimeoutSeconds = options.requestedTimeoutSec; } if (options.terminalId !== undefined) { details.terminalId = options.terminalId; } if (options.wallTimeMs !== undefined) { details.wallTimeMs = options.wallTimeMs; } if (failedExit) { details.exitCode = exitCode; } // Final defense at the tool-result boundary: no bash path (client bridge, // head-retention spill, minimizer miss) may emit more than // ~DEFAULT_MAX_BYTES inline. No-op for already-bounded output. const cappedOutputText = await enforceInlineByteCap(outputText, { saveArtifact: full => saveBashOriginalArtifact(this.session, full), }); const resultBuilder = toolResult(details) .text(cappedOutputText) .truncationFromSummary(result, { direction: "tail" }); if (failedExit) resultBuilder.error(); return resultBuilder.done(); } #buildBackgroundStartResult( jobId: string, label: string, previewText: string, timeoutSec: number, options: { requestedTimeoutSec?: number; notices?: readonly string[] } = {}, ): AgentToolResult { const details: BashToolDetails = { timeoutSeconds: timeoutSec, async: { state: "running", jobId, type: "bash" }, }; if (options.requestedTimeoutSec !== undefined && options.requestedTimeoutSec !== timeoutSec) { details.requestedTimeoutSeconds = options.requestedTimeoutSec; } const lines: string[] = []; const trimmedPreview = previewText.trimEnd(); if (trimmedPreview.length > 0) { lines.push(trimmedPreview, ""); } if (options.notices?.length) { lines.push(...options.notices, ""); } lines.push(`Background job ${jobId} started: ${label}`); lines.push("Result will be delivered automatically when complete."); lines.push( `You can use \`job\` to poll until complete, but prefer to continue with another task in the meanwhile if it's not blocking.`, ); return { content: [{ type: "text", text: lines.join("\n") }], details, }; } #extractTextResult(result: AgentToolResult): string { return result.content.find(block => block.type === "text")?.text ?? ""; } #startManagedBashJob(options: { command: string; commandCwd: string; timeoutMs: number; timeoutSec: number; requestedTimeoutSec?: number; notices?: readonly string[]; resolvedEnv?: Record; onUpdate?: AgentToolUpdateCallback; startBackgrounded: boolean; }): ManagedBashJobHandle { const manager = this.session.asyncJobManager; if (!manager) { throw new ToolError("Background job manager unavailable for this session."); } const label = options.command.length > 120 ? `${options.command.slice(0, 117)}...` : options.command; let latestText = ""; let backgrounded = options.startBackgrounded; const completion = Promise.withResolvers(); const jobId = manager.register( "bash", label, async ({ jobId, signal: runSignal, reportProgress }) => { const { path: artifactPath, id: artifactId } = (await this.session.allocateOutputArtifact?.("bash")) ?? {}; const tailBuffer = new TailBuffer(DEFAULT_MAX_BYTES); const wallTimeStart = performance.now(); try { const result = await executeBash(options.command, { cwd: options.commandCwd, sessionKey: `${this.session.getSessionId?.() ?? ""}:async:${jobId}`, timeout: options.timeoutMs, signal: runSignal, env: options.resolvedEnv, artifactPath, artifactId, onChunk: chunk => { tailBuffer.append(chunk); latestText = tailBuffer.text(); void reportProgress(latestText, { async: { state: "running", jobId, type: "bash" } }); }, onMinimizedSave: originalText => saveBashOriginalArtifact(this.session, originalText), }); const wallTimeMs = performance.now() - wallTimeStart; const finalResult = await this.#buildCompletedResult(result, options.timeoutSec, { requestedTimeoutSec: options.requestedTimeoutSec, notices: options.notices ?? [], wallTimeMs, }); const finalText = this.#extractTextResult(finalResult); latestText = finalText; // Hand the detailed result to the foreground auto-background // waiter (which renders it, footer included) before deciding // the job's terminal state. completion.resolve({ kind: "completed", result: finalResult }); if (finalResult.isError === true) { // A non-zero exit is a completed command that failed. Re-enter // the failure path so the job manager records it as failed and // delivers the error text, matching prior throw-based behavior. throw new ToolError(finalText); } await reportProgress(finalText, { async: { state: "completed", jobId, type: "bash" } }); return finalText; } catch (error) { const message = error instanceof Error ? error.message : String(error); latestText = message; completion.resolve({ kind: "failed", error }); await reportProgress(message, { async: { state: "failed", jobId, type: "bash" } }); throw error; } }, { ownerId: this.session.getAgentId?.() ?? undefined, onProgress: async (text, details) => { latestText = text; await options.onUpdate?.({ content: [{ type: "text", text }], details: backgrounded ? ((details ?? {}) as BashToolDetails) : {}, }); }, }, ); return { jobId, label, completion: completion.promise, getLatestText: () => latestText, setBackgrounded: (nextBackgrounded: boolean) => { backgrounded = nextBackgrounded; }, }; } async #waitForManagedBashJob( job: ManagedBashJobHandle, thresholdMs: number, signal?: AbortSignal, ): Promise { if (signal?.aborted) { return { kind: "aborted" }; } const waiters: Array> = [ job.completion, Bun.sleep(thresholdMs).then(() => ({ kind: "running" as const })), ]; if (!signal) { return await Promise.race(waiters); } const { promise: abortedPromise, resolve: resolveAborted } = Promise.withResolvers<{ kind: "aborted" }>(); const onAbort = () => resolveAborted({ kind: "aborted" }); signal.addEventListener("abort", onAbort, { once: true }); waiters.push(abortedPromise); try { return await Promise.race(waiters); } finally { signal.removeEventListener("abort", onAbort); } } #resolveAutoBackgroundWaitMs(timeoutMs: number): number { if (this.#autoBackgroundThresholdMs <= 0) return 0; const timeoutBufferMs = 1_000; return Math.max(0, Math.min(this.#autoBackgroundThresholdMs, timeoutMs - timeoutBufferMs)); } async execute( _toolCallId: string, { command: rawCommand, env: rawEnv, timeout: rawTimeout = 300, cwd, async: asyncRequested = false, pty = false, }: BashToolInput, signal?: AbortSignal, onUpdate?: AgentToolUpdateCallback, ctx?: AgentToolContext, ): Promise> { let command = rawCommand; const env = normalizeBashEnv(rawEnv); // Apply conservative bash fixups (strip trailing `| head|tail` and redundant // `2>&1`). The helper is single-line only and refuses anything that could // change semantics. if (this.session.settings.get("bash.stripTrailingHeadTail")) { const fixup = applyBashFixups(command); if (fixup.stripped.length > 0) { command = fixup.command; } } // Extract leading `cd && ...` into cwd when the model ignores the cwd parameter. // Constrained to a single line so a `&&` that sits on a later line of a multiline // script can't pull the entire script into the "cwd" capture. if (!cwd) { const cdMatch = command.match(/^cd[ \t]+((?:[^&\\\n\r]|\\.)+?)[ \t]*&&[ \t]*/); // Skip extraction when the path needs shell expansion ($VAR, $(...), // backticks) — resolveToCwd only expands `~`, so routing those through // cwd would reject commands the shell itself handles fine. if (cdMatch && !/[$`(]/.test(cdMatch[1])) { cwd = cdMatch[1].trim().replace(/^["']|["']$/g, ""); command = command.slice(cdMatch[0].length); } } if (asyncRequested && !this.#asyncEnabled) { throw new ToolError("Async bash execution is disabled. Enable async.enabled to use async mode."); } // Check both the original command and the cwd-normalized command so // leading `cd ... &&` wrappers do not hide either shell-navigation rules // or the dedicated-tool command that follows the directory change. if (this.session.settings.get("bashInterceptor.enabled")) { const rules = this.session.settings.getBashInterceptorRules(); const commandsToCheck = rawCommand === command ? [command] : [rawCommand, command]; for (const commandToCheck of commandsToCheck) { const interception = checkBashInterception(commandToCheck, ctx?.toolNames ?? [], rules); if (interception.block) { throw new ToolError(interception.message ?? "Command blocked"); } } } const internalUrlOptions: InternalUrlExpansionOptions = { skills: this.session.skills ?? [], internalRouter: InternalUrlRouter.instance(), localOptions: { getArtifactsDir: this.session.getArtifactsDir, getSessionId: this.session.getSessionId, }, }; command = await expandInternalUrls(command, { ...internalUrlOptions, ensureLocalParentDirs: true }); const resolvedEnv = env ? Object.fromEntries( await Promise.all( Object.entries(env).map(async ([key, value]) => [ key, await expandInternalUrls(value, { ...internalUrlOptions, ensureLocalParentDirs: true, noEscape: true, }), ]), ), ) : undefined; // Resolve protocol URLs (skill://, agent://, etc.) in extracted cwd. if (cwd?.includes("://") || cwd?.includes("local:/")) { cwd = await expandInternalUrls(cwd, { ...internalUrlOptions, noEscape: true }); } // Best-effort cache invalidation: drop github-cache rows for any issue/PR // number touched by a mutating `gh` subcommand inside this bash call so // subsequent issue:// / pr:// reads pick up the post-mutation state // instead of the cached pre-mutation snapshot. invalidateGithubCacheForBashCommand(command); const commandCwd = cwd ? resolveToCwd(cwd, this.session.cwd) : this.session.cwd; let cwdStat: fs.Stats; try { cwdStat = await fs.promises.stat(commandCwd); } catch (err) { if (isEnoent(err)) { throw new ToolError(`Working directory does not exist: ${commandCwd}`); } throw err; } if (!cwdStat.isDirectory()) { throw new ToolError(`Working directory is not a directory: ${commandCwd}`); } // Clamp to reasonable range: 1s - 3600s (1 hour) const requestedTimeoutSec = rawTimeout; const timeoutSec = clampTimeout("bash", requestedTimeoutSec); const timeoutMs = timeoutSec * 1000; const pendingNotices: string[] = []; const timeoutClampNotice = formatTimeoutClampNotice(requestedTimeoutSec, timeoutSec); if (timeoutClampNotice) pendingNotices.push(timeoutClampNotice); if (asyncRequested) { if (!this.session.asyncJobManager) { throw new ToolError("Async job manager unavailable for this session."); } const job = this.#startManagedBashJob({ command, commandCwd, timeoutMs, timeoutSec, requestedTimeoutSec, notices: pendingNotices, resolvedEnv, onUpdate, startBackgrounded: true, }); return this.#buildBackgroundStartResult(job.jobId, job.label, "", timeoutSec, { requestedTimeoutSec, notices: pendingNotices, }); } // The client-bridge terminal provides a live terminal card in the editor; // when available it wins over auto-backgrounding (both are opt-in, and // auto-background would otherwise silently disable the terminal route). const clientBridge = this.session.getClientBridge?.(); const bridgeTerminalAvailable = Boolean( clientBridge?.capabilities.terminal && clientBridge.createTerminal && !pty, ); const autoBgManager = this.session.asyncJobManager; // At the running-job cap, fall through to direct foreground execution // instead of failing every bash call until a slot frees up. if ( this.#autoBackgroundEnabled && !pty && !bridgeTerminalAvailable && autoBgManager && !autoBgManager.atCapacity ) { const autoBackgroundWaitMs = this.#resolveAutoBackgroundWaitMs(timeoutMs); const startBackgrounded = autoBackgroundWaitMs === 0; const job = this.#startManagedBashJob({ command, commandCwd, timeoutMs, timeoutSec, requestedTimeoutSec, notices: pendingNotices, resolvedEnv, onUpdate, startBackgrounded, }); if (startBackgrounded) { return this.#buildBackgroundStartResult(job.jobId, job.label, "", timeoutSec, { requestedTimeoutSec, notices: pendingNotices, }); } // Suppress the completion delivery up front so a job finishing while we // foreground-wait cannot also be injected by the delivery loop. Lifted // via resumeDeliveries() if we end up backgrounding after all. autoBgManager.acknowledgeDeliveries([job.jobId]); const waitResult = await this.#waitForManagedBashJob(job, autoBackgroundWaitMs, signal); if (waitResult.kind === "completed") { return waitResult.result; } if (waitResult.kind === "failed") { throw waitResult.error; } if (waitResult.kind === "aborted") { autoBgManager.cancel(job.jobId); throw new ToolAbortError(job.getLatestText() || "Command aborted"); } job.setBackgrounded(true); autoBgManager.resumeDeliveries([job.jobId]); return this.#buildBackgroundStartResult(job.jobId, job.label, job.getLatestText(), timeoutSec, { requestedTimeoutSec, notices: pendingNotices, }); } // Route through the client terminal when the client advertises the terminal capability. // Skip when pty=true (PTY needs the local terminal UI). if (clientBridge?.capabilities.terminal && clientBridge.createTerminal && !pty) { const bridgeWallTimeStart = performance.now(); const handle = await clientBridge.createTerminal({ command, cwd: commandCwd, env: resolvedEnv ? Object.entries(resolvedEnv).map(([name, value]) => ({ name, value: value as string })) : undefined, outputByteLimit: DEFAULT_MAX_BYTES, }); // Emit partial update so the editor can embed the live terminal card. onUpdate?.({ content: [], details: { terminalId: handle.terminalId } }); const exitPromise = handle.waitForExit(); let exitStatus!: ClientBridgeTerminalExitStatus; type BridgeRaceResult = | { kind: "exit"; status: ClientBridgeTerminalExitStatus } | { kind: "poll" } | { kind: "timeout" } | { kind: "aborted" }; // Set up abort listener before entering the poll loop. The listener // kicks off `handle.kill()` synchronously so a `session/cancel` // arriving mid-poll terminates the remote command immediately, // instead of waiting for the next `currentOutput()` to return. const { promise: abortedP, resolve: resolveAborted } = Promise.withResolvers(); let killStarted = false; const fireKill = (): Promise => { if (killStarted) return Promise.resolve(); killStarted = true; return handle.kill().catch((error: unknown) => { logger.warn("ACP terminal kill failed", { terminalId: handle.terminalId, error }); }); }; const onAbortSignal = () => { resolveAborted(); void fireKill(); }; signal?.addEventListener("abort", onAbortSignal, { once: true }); try { try { if (signal?.aborted) { await fireKill(); throw new ToolAbortError("Command aborted"); } const timeoutPromise = Bun.sleep(timeoutMs).then(() => ({ kind: "timeout" as const })); // Poll until the process exits, times out, or the caller aborts. for (;;) { const racers: Array> = [ exitPromise.then(s => ({ kind: "exit" as const, status: s })), timeoutPromise, Bun.sleep(250).then(() => ({ kind: "poll" as const })), ]; if (signal) { racers.push(abortedP.then(() => ({ kind: "aborted" as const }))); } const raced = await Promise.race(racers); if (raced.kind === "aborted" || signal?.aborted) { await fireKill(); throw new ToolAbortError("Command aborted"); } if (raced.kind === "timeout") { // Kill before reading final output so a slow `terminal/output` // RPC cannot let a timed-out command keep running past the // enforced timeout. The handle stays valid post-kill so the // buffered output is still readable. await fireKill(); let current = { output: "", truncated: false }; try { current = await handle.currentOutput(); } catch (error) { logger.warn("ACP terminal final output read failed", { terminalId: handle.terminalId, error, }); } const timedOutResult: BashInteractiveResult = { output: current.output, exitCode: undefined, cancelled: false, timedOut: true, truncated: current.truncated, totalLines: current.output.length > 0 ? current.output.split("\n").length : 0, totalBytes: current.output.length, outputLines: current.output.length > 0 ? current.output.split("\n").length : 0, outputBytes: current.output.length, }; return this.#buildCompletedResult(timedOutResult, timeoutSec, { requestedTimeoutSec, notices: pendingNotices, terminalId: handle.terminalId, wallTimeMs: performance.now() - bridgeWallTimeStart, }); } if (raced.kind === "exit") { exitStatus = raced.status; break; } // Poll tick: push current output so agent-loop transcript stays consistent. // Race the read against abort so a stuck `terminal/output` RPC does not // delay cancellation. const pollOutput = await Promise.race([ handle.currentOutput(), abortedP.then(() => undefined as ClientBridgeTerminalOutput | undefined), ]); if (pollOutput === undefined) { // Abort fired during the poll-tick read; let the next loop iteration // observe `signal?.aborted` and exit via the abort branch. continue; } onUpdate?.({ content: [{ type: "text", text: pollOutput.output }], details: { terminalId: handle.terminalId }, }); } } finally { signal?.removeEventListener("abort", onAbortSignal); } // Fetch final output; the terminal is released in the outer finally. const finalOutput = await handle.currentOutput(); // Map exit status: null exitCode with a signal → treat as signal kill (137). const rawExitCode = exitStatus.exitCode; const exitCode: number | undefined = rawExitCode != null ? rawExitCode : exitStatus.signal ? 137 : undefined; const outputText = finalOutput.output; const outputByteLen = outputText.length; const outputLineCount = outputText.length > 0 ? outputText.split("\n").length : 0; const bridgeResult: BashResult = { output: outputText, exitCode, cancelled: false, truncated: finalOutput.truncated, totalLines: outputLineCount, totalBytes: outputByteLen, outputLines: outputLineCount, outputBytes: outputByteLen, }; const bridgeNotices: string[] = []; if (finalOutput.truncated) bridgeNotices.push("(output truncated)"); for (const notice of pendingNotices) bridgeNotices.push(notice); return this.#buildCompletedResult(bridgeResult, timeoutSec, { requestedTimeoutSec, notices: bridgeNotices, terminalId: handle.terminalId, wallTimeMs: performance.now() - bridgeWallTimeStart, }); } finally { try { await handle.release(); } catch (error) { logger.warn("ACP terminal release failed", { terminalId: handle.terminalId, error }); } } } // Track output for streaming updates (tail only) const tailBuffer = new TailBuffer(DEFAULT_MAX_BYTES); // Allocate artifact for truncated output storage const { path: artifactPath, id: artifactId } = (await this.session.allocateOutputArtifact?.("bash")) ?? {}; const interactiveUi = canUseInteractiveBashPty(pty, ctx) ? ctx?.ui : undefined; if (pty && !interactiveUi) { pendingNotices.push("pty requested but unavailable in this environment; ran without a terminal"); } const wallTimeStart = performance.now(); const result: BashResult | BashInteractiveResult = interactiveUi ? await runInteractiveBashPty(interactiveUi, { command, cwd: commandCwd, timeoutMs, signal, env: resolvedEnv, artifactPath, artifactId, }) : await executeBash(command, { cwd: commandCwd, sessionKey: this.session.getSessionId?.() ?? undefined, timeout: timeoutMs, signal, env: resolvedEnv, artifactPath, artifactId, onChunk: streamTailUpdates(tailBuffer, onUpdate), onMinimizedSave: originalText => saveBashOriginalArtifact(this.session, originalText), }); const wallTimeMs = performance.now() - wallTimeStart; if (result.cancelled) { const out = normalizeResultOutput(result); // PTY output carries no cancel/timeout notice of its own; annotate so // the model can tell an abort from a plain failure. const message = isInteractiveResult(result) && out ? `${out}\n\n[Command aborted]` : out || "Command aborted"; if (signal?.aborted) { throw new ToolAbortError(message); } throw new ToolError(message); } if (isInteractiveResult(result) && result.timedOut) { const out = normalizeResultOutput(result); throw new ToolError( out ? `${out}\n\n[Command timed out after ${timeoutSec} seconds]` : `Command timed out after ${timeoutSec} seconds`, ); } return this.#buildCompletedResult(result, timeoutSec, { requestedTimeoutSec, notices: pendingNotices, wallTimeMs, }); } } // ============================================================================= // TUI Renderer // ============================================================================= export interface BashRenderArgs { command?: string; env?: Record; timeout?: number; cwd?: string; __partialJson?: string; [key: string]: unknown; } export interface BashRenderContext { /** Raw output text */ output?: string; /** Whether output came from artifact storage */ isFullOutput?: boolean; /** Whether output is expanded */ expanded?: boolean; /** Number of preview lines when collapsed */ previewLines?: number; /** Timeout in seconds */ timeout?: number; } export interface ShellRendererConfig { resolveTitle: (args: TArgs | undefined, options: RenderResultOptions) => string; resolveCommand?: (args: TArgs | undefined) => string | undefined; resolveCwd?: (args: TArgs | undefined) => string | undefined; resolveEnv?: (args: TArgs | undefined) => Record | undefined; showHeader?: boolean; } function getPartialJson(args: TArgs | undefined): string | undefined { if (!args || typeof args !== "object" || !("__partialJson" in args)) return undefined; const value = (args as { __partialJson?: unknown }).__partialJson; return typeof value === "string" ? value : undefined; } export function getBashEnvForDisplay(args: BashRenderArgs): Record | undefined { // During streaming, partial-json parsing often does not surface env values until the object closes. // Recover them from the raw JSON buffer so the pending bash preview can show `NAME="..." cmd` immediately, // instead of rendering only the command and making the env assignment appear at the very end. const partialEnv = extractPartialBashEnv(args.__partialJson); if (partialEnv && args.env) return { ...partialEnv, ...args.env }; return args.env ?? partialEnv; } /** * Returns the bash command formatted for the result body: the dim `$ cd … &&` * prefix joined with syntax-highlighted command lines. The prefix is applied * only to the first line so multi-line commands display cleanly — terminals * reset SGR state at line boundaries, which made the previous single-string * `theme.fg("dim", ...)` form render only the first line as dim. */ export function formatBashCommandLines(args: BashRenderArgs, uiTheme: Theme): string[] { const command = replaceTabs(args.command || "…"); const cwd = getProjectDir(); const displayWorkdir = formatToolWorkingDirectory(args.cwd, cwd); const envAssignments = formatBashEnvAssignments(getBashEnvForDisplay(args)); const prefixParts = ["$"]; if (displayWorkdir) prefixParts.push(`cd ${displayWorkdir} &&`); if (envAssignments) prefixParts.push(envAssignments); const prefix = uiTheme.fg("dim", `${prefixParts.join(" ")} `); const highlightedLines = highlightCode(command, "bash"); if (highlightedLines.length === 0) return [prefix.trimEnd()]; return highlightedLines.map((line, i) => (i === 0 ? `${prefix}${line}` : line)); } function toBashRenderArgs(args: TArgs | undefined, config: ShellRendererConfig): BashRenderArgs { return { command: config.resolveCommand?.(args), cwd: config.resolveCwd?.(args), env: config.resolveEnv?.(args), __partialJson: getPartialJson(args), }; } export function createShellRenderer(config: ShellRendererConfig) { return { renderCall(args: TArgs, options: RenderResultOptions, uiTheme: Theme): Component { const renderArgs = toBashRenderArgs(args, config); const cmdLines = formatBashCommandLines(renderArgs, uiTheme); const header = config.showHeader === false ? undefined : renderStatusLine({ icon: "pending", title: config.resolveTitle(args, options) }, uiTheme); const outputBlock = new CachedOutputBlock(); return markFramedBlockComponent({ render: (width: number): readonly string[] => outputBlock.render( { header, state: "pending", sections: [{ lines: capPreviewLines(cmdLines, uiTheme, { expanded: options.expanded }) }], width, }, uiTheme, ), invalidate: () => { outputBlock.invalidate(); }, }); }, renderResult( result: { content: Array<{ type: string; text?: string }>; details?: BashToolDetails; isError?: boolean; }, options: RenderResultOptions & { renderContext?: BashRenderContext }, uiTheme: Theme, args?: TArgs, ): Component { const renderArgs = toBashRenderArgs(args, config); const cmdLines = args ? formatBashCommandLines(renderArgs, uiTheme) : undefined; const isError = result.isError === true; const isPartial = options.isPartial === true; const success = !isPartial && !isError; const header = config.showHeader === false ? undefined : renderStatusLine( success ? { iconOverride: uiTheme.styledSymbol("tool.bash", "accent"), title: config.resolveTitle(args, options), } : { icon: isPartial ? "pending" : "error", title: config.resolveTitle(args, options), }, uiTheme, ); const details = result.details; const outputBlock = new CachedOutputBlock(); // Per-instance cache for the expensive inner lines computation. Mirrors // the eval-renderer pattern (`eval-render.ts:709-752`): without this, // every TUI repaint (one per keystroke when a long transcript is on // screen) re-runs `split` / `replaceTabs` / `truncateToVisualLines` over // the whole stored output for every bash row in scrollback. With a // 50KB-tail bash result times hundreds of rows, that re-rendering is // what pinned the main thread in issue #2081 and made keystrokes feel // like the CPU was at 100%. The cache key includes every render input // that materially affects the produced lines. let cachedWidth: number | undefined; let cachedPreviewLines: number | undefined; let cachedExpanded: boolean | undefined; let cachedRawOutput: string | undefined; let cachedIsPartial: boolean | undefined; let cachedLines: readonly string[] | undefined; let cachedPreviewWindow: number | undefined; return markFramedBlockComponent({ render: (width: number): readonly string[] => { // REACTIVE: read mutable options at render time const { renderContext } = options; const expanded = renderContext?.expanded ?? options.expanded; const previewLines = renderContext?.previewLines ?? BASH_DEFAULT_PREVIEW_LINES; // Get output from context (preferred) or fall back to result content. // Strip the LLM-facing notice appended by wrappedExecute so we don't // double-print it alongside the styled warning line below. const rawOutput = renderContext?.output ?? result.content?.find(c => c.type === "text")?.text ?? ""; const isPartial = options.isPartial === true; const previewWindow = previewWindowRows(); if ( cachedLines !== undefined && cachedWidth === width && cachedPreviewLines === previewLines && cachedExpanded === expanded && cachedRawOutput === rawOutput && cachedIsPartial === isPartial && cachedPreviewWindow === previewWindow ) { return cachedLines; } const strippedOutput = stripOutputNotice(rawOutput, details?.meta); const withoutExit = stripExitCodeNotice(strippedOutput, details?.exitCode); const withoutWall = stripWallTimeNotice(withoutExit, details?.wallTimeMs); const rawOutputArtifact = stripRawOutputArtifactNotice(withoutWall); const output = rawOutputArtifact.text; const displayOutput = output.trimEnd(); const showingFullOutput = expanded && renderContext?.isFullOutput === true; // Build truncation warning const timeoutSeconds = details?.timeoutSeconds ?? renderContext?.timeout; const requestedTimeoutSeconds = details?.requestedTimeoutSeconds; const wallTimeMs = details?.wallTimeMs; const statsParts: string[] = []; if (wallTimeMs !== undefined) { statsParts.push(`Wall: ${formatWallTimeSeconds(wallTimeMs)}s`); } if (typeof timeoutSeconds === "number") { statsParts.push( requestedTimeoutSeconds !== undefined && requestedTimeoutSeconds !== timeoutSeconds ? `Timeout: ${timeoutSeconds}s (requested ${requestedTimeoutSeconds}s clamped)` : `Timeout: ${timeoutSeconds}s`, ); } if (rawOutputArtifact.artifactId) { statsParts.push(`Artifact: ${rawOutputArtifact.artifactId}`); } if (isError && typeof details?.exitCode === "number") { statsParts.push(`Exit: ${details.exitCode}`); } const timeoutLine = statsParts.length > 0 ? uiTheme.fg( "dim", `${uiTheme.format.bracketLeft}${statsParts.join(" | ")}${uiTheme.format.bracketRight}`, ) : undefined; let warningLine: string | undefined; if (details?.meta?.truncation && !showingFullOutput) { warningLine = formatStyledTruncationWarning(details.meta, uiTheme) ?? undefined; } const outputLines: string[] = []; const hasOutput = displayOutput.trim().length > 0; const rawOutputLines = displayOutput.split("\n"); const sixelLineMask = TERMINAL.imageProtocol === ImageProtocol.Sixel ? getSixelLineMask(rawOutputLines) : undefined; const hasSixelOutput = sixelLineMask?.some(Boolean) ?? false; if (hasOutput) { if (hasSixelOutput) { outputLines.push( ...rawOutputLines.map((line, index) => sixelLineMask?.[index] ? line : uiTheme.fg("toolOutput", replaceTabs(line)), ), ); } else if (expanded) { outputLines.push(...rawOutputLines.map(line => uiTheme.fg("toolOutput", replaceTabs(line)))); } else { const styledOutput = rawOutputLines .map(line => uiTheme.fg("toolOutput", replaceTabs(line))) .join("\n"); const textContent = styledOutput; const result = truncateToVisualLines(textContent, previewLines, width); if (result.skippedCount > 0) { outputLines.push( uiTheme.fg( "dim", `… (${result.skippedCount} earlier lines, showing ${result.visualLines.length} of ${result.skippedCount + result.visualLines.length}) (ctrl+o to expand)`, ), ); } outputLines.push(...result.visualLines); } } if (timeoutLine) outputLines.push(timeoutLine); if (warningLine) outputLines.push(warningLine); const framed = outputBlock.render( { header, state: isPartial ? "pending" : isError ? "error" : "success", sections: [ { // Viewport-sized tail window in every state — streaming and final // render identically; only ctrl+o uncaps. lines: capPreviewLines(cmdLines ?? [], uiTheme, { expanded }), }, { label: uiTheme.fg("toolTitle", "Output"), lines: outputLines }, ], width, }, uiTheme, ); cachedWidth = width; cachedPreviewLines = previewLines; cachedExpanded = expanded; cachedRawOutput = rawOutput; cachedIsPartial = isPartial; cachedPreviewWindow = previewWindow; cachedLines = framed; return framed; }, invalidate: () => { outputBlock.invalidate(); cachedLines = undefined; cachedWidth = undefined; cachedPreviewLines = undefined; cachedExpanded = undefined; cachedRawOutput = undefined; cachedIsPartial = undefined; cachedPreviewWindow = undefined; }, }); }, mergeCallAndResult: true, inline: true, // Collapsed pending preview caps the command to a viewport-sized tail // window that shifts while args stream. Expanded output is top-anchored // enough for the transcript to commit its settled prefix. provisionalPendingPreview: "collapsed", }; } export const bashToolRenderer = createShellRenderer({ resolveTitle: () => "Bash", resolveCommand: args => args?.command, resolveCwd: args => args?.cwd, resolveEnv: args => args?.env, showHeader: false, });