summaryrefslogtreecommitdiff
path: root/packages/cli/src/tools
diff options
context:
space:
mode:
Diffstat (limited to 'packages/cli/src/tools')
-rw-r--r--packages/cli/src/tools/edit.tool.ts632
-rw-r--r--packages/cli/src/tools/glob.tool.ts91
-rw-r--r--packages/cli/src/tools/grep.tool.ts233
-rw-r--r--packages/cli/src/tools/ls.tool.ts60
-rw-r--r--packages/cli/src/tools/read-file.tool.ts63
-rw-r--r--packages/cli/src/tools/terminal.tool.ts1808
-rw-r--r--packages/cli/src/tools/tool-registry.ts88
-rw-r--r--packages/cli/src/tools/tools.ts31
-rw-r--r--packages/cli/src/tools/write-file.tool.ts52
9 files changed, 1757 insertions, 1301 deletions
diff --git a/packages/cli/src/tools/edit.tool.ts b/packages/cli/src/tools/edit.tool.ts
index 52ef4fe8..a98b9861 100644
--- a/packages/cli/src/tools/edit.tool.ts
+++ b/packages/cli/src/tools/edit.tool.ts
@@ -3,7 +3,11 @@ import path from 'path';
import * as Diff from 'diff';
import { SchemaValidator } from '../utils/schemaValidator.js';
import { BaseTool, ToolResult } from './tools.js';
-import { ToolCallConfirmationDetails, ToolConfirmationOutcome, ToolEditConfirmationDetails } from '../ui/types.js';
+import {
+ ToolCallConfirmationDetails,
+ ToolConfirmationOutcome,
+ ToolEditConfirmationDetails,
+} from '../ui/types.js';
import { makeRelative, shortenPath } from '../utils/paths.js';
import { ReadFileTool } from './read-file.tool.js';
import { WriteFileTool } from './write-file.tool.js';
@@ -12,39 +16,38 @@ import { WriteFileTool } from './write-file.tool.js';
* Parameters for the Edit tool
*/
export interface EditToolParams {
- /**
- * The absolute path to the file to modify
- */
- file_path: string;
+ /**
+ * The absolute path to the file to modify
+ */
+ file_path: string;
- /**
- * The text to replace
- */
- old_string: string;
+ /**
+ * The text to replace
+ */
+ old_string: string;
- /**
- * The text to replace it with
- */
- new_string: string;
+ /**
+ * The text to replace it with
+ */
+ new_string: string;
- /**
- * The expected number of replacements to perform (optional, defaults to 1)
- */
- expected_replacements?: number;
+ /**
+ * The expected number of replacements to perform (optional, defaults to 1)
+ */
+ expected_replacements?: number;
}
/**
* Result from the Edit tool
*/
-export interface EditToolResult extends ToolResult {
-}
+export interface EditToolResult extends ToolResult {}
interface CalculatedEdit {
- currentContent: string | null;
- newContent: string;
- occurrences: number;
- error?: { display: string, raw: string };
- isNewFile: boolean;
+ currentContent: string | null;
+ newContent: string;
+ occurrences: number;
+ error?: { display: string; raw: string };
+ isNewFile: boolean;
}
/**
@@ -52,317 +55,350 @@ interface CalculatedEdit {
* This tool maintains state for the "Always Edit" confirmation preference.
*/
export class EditTool extends BaseTool<EditToolParams, EditToolResult> {
- private shouldAlwaysEdit = false;
- private readonly rootDirectory: string;
+ private shouldAlwaysEdit = false;
+ private readonly rootDirectory: string;
- /**
- * Creates a new instance of the EditTool
- * @param rootDirectory Root directory to ground this tool in.
- */
- constructor(rootDirectory: string) {
- super(
- 'replace',
- 'Edit',
- `Replaces a SINGLE, UNIQUE occurrence of text within a file. Requires providing significant context around the change to ensure uniqueness. For moving/renaming files, use the Bash tool with \`mv\`. For replacing entire file contents or creating new files use the ${WriteFileTool.Name} tool. Always use the ${ReadFileTool.Name} tool to examine the file before using this tool.`,
- {
- properties: {
- file_path: {
- description: 'The absolute path to the file to modify. Must start with /. When creating a new file, ensure the parent directory exists (use the `LS` tool to verify).',
- type: 'string'
- },
- old_string: {
- description: 'The exact text to replace. CRITICAL: Must uniquely identify the single instance to change. Include at least 3-5 lines of context BEFORE and AFTER the target text, matching whitespace and indentation precisely. If this string matches multiple locations or does not match exactly, the tool will fail. Use an empty string ("") when creating a new file.',
- type: 'string'
- },
- new_string: {
- description: 'The text to replace the `old_string` with. When creating a new file (using an empty `old_string`), this should contain the full desired content of the new file. Ensure the resulting code is correct and idiomatic.',
- type: 'string'
- }
- },
- required: ['file_path', 'old_string', 'new_string'],
- type: 'object'
- }
- );
- this.rootDirectory = path.resolve(rootDirectory);
- }
+ /**
+ * Creates a new instance of the EditTool
+ * @param rootDirectory Root directory to ground this tool in.
+ */
+ constructor(rootDirectory: string) {
+ super(
+ 'replace',
+ 'Edit',
+ `Replaces a SINGLE, UNIQUE occurrence of text within a file. Requires providing significant context around the change to ensure uniqueness. For moving/renaming files, use the Bash tool with \`mv\`. For replacing entire file contents or creating new files use the ${WriteFileTool.Name} tool. Always use the ${ReadFileTool.Name} tool to examine the file before using this tool.`,
+ {
+ properties: {
+ file_path: {
+ description:
+ 'The absolute path to the file to modify. Must start with /. When creating a new file, ensure the parent directory exists (use the `LS` tool to verify).',
+ type: 'string',
+ },
+ old_string: {
+ description:
+ 'The exact text to replace. CRITICAL: Must uniquely identify the single instance to change. Include at least 3-5 lines of context BEFORE and AFTER the target text, matching whitespace and indentation precisely. If this string matches multiple locations or does not match exactly, the tool will fail. Use an empty string ("") when creating a new file.',
+ type: 'string',
+ },
+ new_string: {
+ description:
+ 'The text to replace the `old_string` with. When creating a new file (using an empty `old_string`), this should contain the full desired content of the new file. Ensure the resulting code is correct and idiomatic.',
+ type: 'string',
+ },
+ },
+ required: ['file_path', 'old_string', 'new_string'],
+ type: 'object',
+ },
+ );
+ this.rootDirectory = path.resolve(rootDirectory);
+ }
- /**
- * Checks if a path is within the root directory.
- * @param pathToCheck The absolute path to check.
- * @returns True if the path is within the root directory, false otherwise.
- */
- private isWithinRoot(pathToCheck: string): boolean {
- const normalizedPath = path.normalize(pathToCheck);
- const normalizedRoot = this.rootDirectory;
+ /**
+ * Checks if a path is within the root directory.
+ * @param pathToCheck The absolute path to check.
+ * @returns True if the path is within the root directory, false otherwise.
+ */
+ private isWithinRoot(pathToCheck: string): boolean {
+ const normalizedPath = path.normalize(pathToCheck);
+ const normalizedRoot = this.rootDirectory;
- const rootWithSep = normalizedRoot.endsWith(path.sep)
- ? normalizedRoot
- : normalizedRoot + path.sep;
+ const rootWithSep = normalizedRoot.endsWith(path.sep)
+ ? normalizedRoot
+ : normalizedRoot + path.sep;
- return normalizedPath === normalizedRoot || normalizedPath.startsWith(rootWithSep);
+ return (
+ normalizedPath === normalizedRoot ||
+ normalizedPath.startsWith(rootWithSep)
+ );
+ }
+
+ /**
+ * Validates the parameters for the Edit tool
+ * @param params Parameters to validate
+ * @returns True if parameters are valid, false otherwise
+ */
+ validateParams(params: EditToolParams): boolean {
+ if (
+ this.schema.parameters &&
+ !SchemaValidator.validate(
+ this.schema.parameters as Record<string, unknown>,
+ params,
+ )
+ ) {
+ return false;
}
- /**
- * Validates the parameters for the Edit tool
- * @param params Parameters to validate
- * @returns True if parameters are valid, false otherwise
- */
- validateParams(params: EditToolParams): boolean {
- if (this.schema.parameters && !SchemaValidator.validate(this.schema.parameters as Record<string, unknown>, params)) {
- return false;
- }
+ // Ensure path is absolute
+ if (!path.isAbsolute(params.file_path)) {
+ console.error(`File path must be absolute: ${params.file_path}`);
+ return false;
+ }
- // Ensure path is absolute
- if (!path.isAbsolute(params.file_path)) {
- console.error(`File path must be absolute: ${params.file_path}`);
- return false;
- }
+ // Ensure path is within the root directory
+ if (!this.isWithinRoot(params.file_path)) {
+ console.error(
+ `File path must be within the root directory (${this.rootDirectory}): ${params.file_path}`,
+ );
+ return false;
+ }
- // Ensure path is within the root directory
- if (!this.isWithinRoot(params.file_path)) {
- console.error(`File path must be within the root directory (${this.rootDirectory}): ${params.file_path}`);
- return false;
- }
+ // Validate expected_replacements if provided
+ if (
+ params.expected_replacements !== undefined &&
+ params.expected_replacements < 0
+ ) {
+ console.error('Expected replacements must be a non-negative number');
+ return false;
+ }
+ return true;
+ }
- // Validate expected_replacements if provided
- if (params.expected_replacements !== undefined && params.expected_replacements < 0) {
- console.error('Expected replacements must be a non-negative number');
- return false;
- }
+ /**
+ * Calculates the potential outcome of an edit operation.
+ * @param params Parameters for the edit operation
+ * @returns An object describing the potential edit outcome
+ * @throws File system errors if reading the file fails unexpectedly (e.g., permissions)
+ */
+ private calculateEdit(params: EditToolParams): CalculatedEdit {
+ const expectedReplacements =
+ params.expected_replacements === undefined
+ ? 1
+ : params.expected_replacements;
+ let currentContent: string | null = null;
+ let fileExists = false;
+ let isNewFile = false;
+ let newContent = '';
+ let occurrences = 0;
+ let error: { display: string; raw: string } | undefined = undefined;
- return true;
+ try {
+ currentContent = fs.readFileSync(params.file_path, 'utf8');
+ fileExists = true;
+ } catch (err: any) {
+ if (err.code !== 'ENOENT') {
+ throw err;
+ }
+ fileExists = false;
}
- /**
- * Calculates the potential outcome of an edit operation.
- * @param params Parameters for the edit operation
- * @returns An object describing the potential edit outcome
- * @throws File system errors if reading the file fails unexpectedly (e.g., permissions)
- */
- private calculateEdit(params: EditToolParams): CalculatedEdit {
- const expectedReplacements = params.expected_replacements === undefined ? 1 : params.expected_replacements;
- let currentContent: string | null = null;
- let fileExists = false;
- let isNewFile = false;
- let newContent = '';
- let occurrences = 0;
- let error: { display: string, raw: string } | undefined = undefined;
+ if (params.old_string === '' && !fileExists) {
+ isNewFile = true;
+ newContent = params.new_string;
+ occurrences = 0;
+ } else if (!fileExists) {
+ error = {
+ display: `File not found.`,
+ raw: `File not found: ${params.file_path}`,
+ };
+ } else if (currentContent !== null) {
+ occurrences = this.countOccurrences(currentContent, params.old_string);
- try {
- currentContent = fs.readFileSync(params.file_path, 'utf8');
- fileExists = true;
- } catch (err: any) {
- if (err.code !== 'ENOENT') {
- throw err;
- }
- fileExists = false;
- }
+ if (occurrences === 0) {
+ error = {
+ display: `No edits made`,
+ raw: `Failed to edit, 0 occurrences found`,
+ };
+ } else if (occurrences !== expectedReplacements) {
+ error = {
+ display: `Failed to edit, expected ${expectedReplacements} occurrences but found ${occurrences}`,
+ raw: `Failed to edit, Expected ${expectedReplacements} occurrences but found ${occurrences} in file: ${params.file_path}`,
+ };
+ } else {
+ newContent = this.replaceAll(
+ currentContent,
+ params.old_string,
+ params.new_string,
+ );
+ }
+ } else {
+ error = {
+ display: `Failed to read content`,
+ raw: `Failed to read content of existing file: ${params.file_path}`,
+ };
+ }
- if (params.old_string === '' && !fileExists) {
- isNewFile = true;
- newContent = params.new_string;
- occurrences = 0;
- } else if (!fileExists) {
- error = {
- display: `File not found.`,
- raw: `File not found: ${params.file_path}`
- };
- } else if (currentContent !== null) {
- occurrences = this.countOccurrences(currentContent, params.old_string);
+ return {
+ currentContent,
+ newContent,
+ occurrences,
+ error,
+ isNewFile,
+ };
+ }
- if (occurrences === 0) {
- error = {
- display: `No edits made`,
- raw: `Failed to edit, 0 occurrences found`
- }
- } else if (occurrences !== expectedReplacements) {
- error = {
- display: `Failed to edit, expected ${expectedReplacements} occurrences but found ${occurrences}`,
- raw: `Failed to edit, Expected ${expectedReplacements} occurrences but found ${occurrences} in file: ${params.file_path}`
- }
- } else {
- newContent = this.replaceAll(currentContent, params.old_string, params.new_string);
- }
- } else {
- error = {
- display: `Failed to read content`,
- raw: `Failed to read content of existing file: ${params.file_path}`
- }
- }
+ /**
+ * Determines if confirmation is needed and prepares the confirmation details.
+ * This method performs the calculation needed to generate the diff and respects the `shouldAlwaysEdit` state.
+ * @param params Parameters for the potential edit operation
+ * @returns Confirmation details object or false if no confirmation is needed/possible.
+ */
+ async shouldConfirmExecute(
+ params: EditToolParams,
+ ): Promise<ToolCallConfirmationDetails | false> {
+ if (this.shouldAlwaysEdit) {
+ return false;
+ }
- return {
- currentContent,
- newContent,
- occurrences,
- error,
- isNewFile
- };
+ if (!this.validateParams(params)) {
+ console.error(
+ '[EditTool] Attempted confirmation with invalid parameters.',
+ );
+ return false;
}
- /**
- * Determines if confirmation is needed and prepares the confirmation details.
- * This method performs the calculation needed to generate the diff and respects the `shouldAlwaysEdit` state.
- * @param params Parameters for the potential edit operation
- * @returns Confirmation details object or false if no confirmation is needed/possible.
- */
- async shouldConfirmExecute(params: EditToolParams): Promise<ToolCallConfirmationDetails | false> {
- if (this.shouldAlwaysEdit) {
- return false;
- }
+ let calculatedEdit: CalculatedEdit;
+ try {
+ calculatedEdit = this.calculateEdit(params);
+ } catch (error) {
+ console.error(
+ `Error calculating edit for confirmation: ${error instanceof Error ? error.message : String(error)}`,
+ );
+ return false;
+ }
- if (!this.validateParams(params)) {
- console.error("[EditTool] Attempted confirmation with invalid parameters.");
- return false;
- }
+ if (calculatedEdit.error) {
+ return false;
+ }
- let calculatedEdit: CalculatedEdit;
- try {
- calculatedEdit = this.calculateEdit(params);
- } catch (error) {
- console.error(`Error calculating edit for confirmation: ${error instanceof Error ? error.message : String(error)}`);
- return false;
- }
+ const fileName = path.basename(params.file_path);
+ const fileDiff = Diff.createPatch(
+ fileName,
+ calculatedEdit.currentContent ?? '',
+ calculatedEdit.newContent,
+ 'Current',
+ 'Proposed',
+ { context: 3, ignoreWhitespace: true },
+ );
- if (calculatedEdit.error) {
- return false;
+ const confirmationDetails: ToolEditConfirmationDetails = {
+ title: `Confirm Edit: ${shortenPath(makeRelative(params.file_path, this.rootDirectory))}`,
+ fileName,
+ fileDiff,
+ onConfirm: async (outcome: ToolConfirmationOutcome) => {
+ if (outcome === ToolConfirmationOutcome.ProceedAlways) {
+ this.shouldAlwaysEdit = true;
}
+ },
+ };
+ return confirmationDetails;
+ }
- const fileName = path.basename(params.file_path);
- const fileDiff = Diff.createPatch(
- fileName,
- calculatedEdit.currentContent ?? '',
- calculatedEdit.newContent,
- 'Current',
- 'Proposed',
- { context: 3, ignoreWhitespace: true, }
- );
+ getDescription(params: EditToolParams): string {
+ const relativePath = makeRelative(params.file_path, this.rootDirectory);
+ const oldStringSnippet =
+ params.old_string.split('\n')[0].substring(0, 30) +
+ (params.old_string.length > 30 ? '...' : '');
+ const newStringSnippet =
+ params.new_string.split('\n')[0].substring(0, 30) +
+ (params.new_string.length > 30 ? '...' : '');
+ return `${shortenPath(relativePath)}: ${oldStringSnippet} => ${newStringSnippet}`;
+ }
- const confirmationDetails: ToolEditConfirmationDetails = {
- title: `Confirm Edit: ${shortenPath(makeRelative(params.file_path, this.rootDirectory))}`,
- fileName,
- fileDiff,
- onConfirm: async (outcome: ToolConfirmationOutcome) => {
- if (outcome === ToolConfirmationOutcome.ProceedAlways) {
- this.shouldAlwaysEdit = true;
- }
- },
- };
- return confirmationDetails;
+ /**
+ * Executes the edit operation with the given parameters.
+ * This method recalculates the edit operation before execution.
+ * @param params Parameters for the edit operation
+ * @returns Result of the edit operation
+ */
+ async execute(params: EditToolParams): Promise<EditToolResult> {
+ if (!this.validateParams(params)) {
+ return {
+ llmContent: 'Invalid parameters for file edit operation',
+ returnDisplay: '**Error:** Invalid parameters for file edit operation',
+ };
}
- getDescription(params: EditToolParams): string {
- const relativePath = makeRelative(params.file_path, this.rootDirectory);
- const oldStringSnippet = params.old_string.split('\n')[0].substring(0, 30) + (params.old_string.length > 30 ? '...' : '');
- const newStringSnippet = params.new_string.split('\n')[0].substring(0, 30) + (params.new_string.length > 30 ? '...' : '');
- return `${shortenPath(relativePath)}: ${oldStringSnippet} => ${newStringSnippet}`;
+ let editData: CalculatedEdit;
+ try {
+ editData = this.calculateEdit(params);
+ } catch (error) {
+ return {
+ llmContent: `Error preparing edit: ${error instanceof Error ? error.message : String(error)}`,
+ returnDisplay: 'Failed to prepare edit',
+ };
}
- /**
- * Executes the edit operation with the given parameters.
- * This method recalculates the edit operation before execution.
- * @param params Parameters for the edit operation
- * @returns Result of the edit operation
- */
- async execute(params: EditToolParams): Promise<EditToolResult> {
- if (!this.validateParams(params)) {
- return {
- llmContent: 'Invalid parameters for file edit operation',
- returnDisplay: '**Error:** Invalid parameters for file edit operation'
- };
- }
-
- let editData: CalculatedEdit;
- try {
- editData = this.calculateEdit(params);
- } catch (error) {
- return {
- llmContent: `Error preparing edit: ${error instanceof Error ? error.message : String(error)}`,
- returnDisplay: 'Failed to prepare edit'
- };
- }
-
- if (editData.error) {
- return {
- llmContent: editData.error.raw,
- returnDisplay: editData.error.display
- };
- }
+ if (editData.error) {
+ return {
+ llmContent: editData.error.raw,
+ returnDisplay: editData.error.display,
+ };
+ }
- try {
- this.ensureParentDirectoriesExist(params.file_path);
- fs.writeFileSync(params.file_path, editData.newContent, 'utf8');
+ try {
+ this.ensureParentDirectoriesExist(params.file_path);
+ fs.writeFileSync(params.file_path, editData.newContent, 'utf8');
- if (editData.isNewFile) {
- return {
- llmContent: `Created new file: ${params.file_path} with provided content.`,
- returnDisplay: `Created ${shortenPath(makeRelative(params.file_path, this.rootDirectory))}`
- };
- } else {
- const fileName = path.basename(params.file_path);
- const fileDiff = Diff.createPatch(
- fileName,
- editData.currentContent ?? '',
- editData.newContent,
- 'Current',
- 'Proposed',
- { context: 3, ignoreWhitespace: true }
- );
+ if (editData.isNewFile) {
+ return {
+ llmContent: `Created new file: ${params.file_path} with provided content.`,
+ returnDisplay: `Created ${shortenPath(makeRelative(params.file_path, this.rootDirectory))}`,
+ };
+ } else {
+ const fileName = path.basename(params.file_path);
+ const fileDiff = Diff.createPatch(
+ fileName,
+ editData.currentContent ?? '',
+ editData.newContent,
+ 'Current',
+ 'Proposed',
+ { context: 3, ignoreWhitespace: true },
+ );
- return {
- llmContent: `Successfully modified file: ${params.file_path} (${editData.occurrences} replacements).`,
- returnDisplay: { fileDiff }
- };
- }
- } catch (error) {
- return {
- llmContent: `Error executing edit: ${error instanceof Error ? error.message : String(error)}`,
- returnDisplay: `Failed to edit file`
- };
- }
+ return {
+ llmContent: `Successfully modified file: ${params.file_path} (${editData.occurrences} replacements).`,
+ returnDisplay: { fileDiff },
+ };
+ }
+ } catch (error) {
+ return {
+ llmContent: `Error executing edit: ${error instanceof Error ? error.message : String(error)}`,
+ returnDisplay: `Failed to edit file`,
+ };
}
+ }
- /**
- * Counts occurrences of a substring in a string
- * @param str String to search in
- * @param substr Substring to count
- * @returns Number of occurrences
- */
- private countOccurrences(str: string, substr: string): number {
- if (substr === '') {
- return 0;
- }
- let count = 0;
- let pos = str.indexOf(substr);
- while (pos !== -1) {
- count++;
- pos = str.indexOf(substr, pos + substr.length);
- }
- return count;
+ /**
+ * Counts occurrences of a substring in a string
+ * @param str String to search in
+ * @param substr Substring to count
+ * @returns Number of occurrences
+ */
+ private countOccurrences(str: string, substr: string): number {
+ if (substr === '') {
+ return 0;
}
+ let count = 0;
+ let pos = str.indexOf(substr);
+ while (pos !== -1) {
+ count++;
+ pos = str.indexOf(substr, pos + substr.length);
+ }
+ return count;
+ }
- /**
- * Replaces all occurrences of a substring in a string
- * @param str String to modify
- * @param find Substring to find
- * @param replace Replacement string
- * @returns Modified string
- */
- private replaceAll(str: string, find: string, replace: string): string {
- if (find === '') {
- return str;
- }
- return str.split(find).join(replace);
+ /**
+ * Replaces all occurrences of a substring in a string
+ * @param str String to modify
+ * @param find Substring to find
+ * @param replace Replacement string
+ * @returns Modified string
+ */
+ private replaceAll(str: string, find: string, replace: string): string {
+ if (find === '') {
+ return str;
}
+ return str.split(find).join(replace);
+ }
- /**
- * Creates parent directories if they don't exist
- * @param filePath Path to ensure parent directories exist
- */
- private ensureParentDirectoriesExist(filePath: string): void {
- const dirName = path.dirname(filePath);
- if (!fs.existsSync(dirName)) {
- fs.mkdirSync(dirName, { recursive: true });
- }
+ /**
+ * Creates parent directories if they don't exist
+ * @param filePath Path to ensure parent directories exist
+ */
+ private ensureParentDirectoriesExist(filePath: string): void {
+ const dirName = path.dirname(filePath);
+ if (!fs.existsSync(dirName)) {
+ fs.mkdirSync(dirName, { recursive: true });
}
+ }
}
diff --git a/packages/cli/src/tools/glob.tool.ts b/packages/cli/src/tools/glob.tool.ts
index b63aa1cc..6c14b7d1 100644
--- a/packages/cli/src/tools/glob.tool.ts
+++ b/packages/cli/src/tools/glob.tool.ts
@@ -23,8 +23,7 @@ export interface GlobToolParams {
/**
* Result from the GlobTool
*/
-export interface GlobToolResult extends ToolResult {
-}
+export interface GlobToolResult extends ToolResult {}
/**
* Implementation of the GlobTool that finds files matching patterns,
@@ -49,17 +48,19 @@ export class GlobTool extends BaseTool<GlobToolParams, GlobToolResult> {
{
properties: {
pattern: {
- description: 'The glob pattern to match against (e.g., \'*.py\', \'src/**/*.js\', \'docs/*.md\').',
- type: 'string'
+ description:
+ "The glob pattern to match against (e.g., '*.py', 'src/**/*.js', 'docs/*.md').",
+ type: 'string',
},
path: {
- description: 'Optional: The absolute path to the directory to search within. If omitted, searches the root directory.',
- type: 'string'
- }
+ description:
+ 'Optional: The absolute path to the directory to search within. If omitted, searches the root directory.',
+ type: 'string',
+ },
},
required: ['pattern'],
- type: 'object'
- }
+ type: 'object',
+ },
);
// Set the root directory
@@ -84,7 +85,10 @@ export class GlobTool extends BaseTool<GlobToolParams, GlobToolResult> {
// Check if it's the root itself or starts with the root path followed by a separator.
// This ensures that we don't accidentally allow access to parent directories.
- return normalizedPath === normalizedRoot || normalizedPath.startsWith(rootWithSep);
+ return (
+ normalizedPath === normalizedRoot ||
+ normalizedPath.startsWith(rootWithSep)
+ );
}
/**
@@ -94,7 +98,13 @@ export class GlobTool extends BaseTool<GlobToolParams, GlobToolResult> {
* @returns An error message string if invalid, null otherwise
*/
invalidParams(params: GlobToolParams): string | null {
- if (this.schema.parameters && !SchemaValidator.validate(this.schema.parameters as Record<string, unknown>, params)) {
+ if (
+ this.schema.parameters &&
+ !SchemaValidator.validate(
+ this.schema.parameters as Record<string, unknown>,
+ params,
+ )
+ ) {
return "Parameters failed schema validation. Ensure 'pattern' is a string and 'path' (if provided) is a string.";
}
@@ -121,8 +131,12 @@ export class GlobTool extends BaseTool<GlobToolParams, GlobToolResult> {
}
// Validate glob pattern (basic non-empty check)
- if (!params.pattern || typeof params.pattern !== 'string' || params.pattern.trim() === '') {
- return "The 'pattern' parameter cannot be empty.";
+ if (
+ !params.pattern ||
+ typeof params.pattern !== 'string' ||
+ params.pattern.trim() === ''
+ ) {
+ return "The 'pattern' parameter cannot be empty.";
}
// Could add more sophisticated glob pattern validation if needed
@@ -156,7 +170,7 @@ export class GlobTool extends BaseTool<GlobToolParams, GlobToolResult> {
if (validationError) {
return {
llmContent: `Error: Invalid parameters provided. Reason: ${validationError}`,
- returnDisplay: `**Error:** Failed to execute tool.`
+ returnDisplay: `**Error:** Failed to execute tool.`,
};
}
@@ -168,10 +182,10 @@ export class GlobTool extends BaseTool<GlobToolParams, GlobToolResult> {
// We use fast-glob because it's performant and supports glob patterns.
const entries = await fg(params.pattern, {
cwd: searchDirAbsolute, // Search within this absolute directory
- absolute: true, // Return absolute paths
- onlyFiles: true, // Match only files
- stats: true, // Include file stats object for sorting
- dot: true, // Include files starting with a dot
+ absolute: true, // Return absolute paths
+ onlyFiles: true, // Match only files
+ stats: true, // Include file stats object for sorting
+ dot: true, // Include files starting with a dot
ignore: ['**/node_modules/**', '**/.git/**'], // Common sensible default, adjust as needed
followSymbolicLinks: false, // Avoid potential issues with symlinks unless specifically needed
suppressErrors: true, // Suppress EACCES errors for individual files (we handle dir access in validation)
@@ -181,7 +195,7 @@ export class GlobTool extends BaseTool<GlobToolParams, GlobToolResult> {
if (!entries || entries.length === 0) {
return {
llmContent: `No files found matching pattern "${params.pattern}" within ${searchDirAbsolute}.`,
- returnDisplay: `No files found`
+ returnDisplay: `No files found`,
};
}
@@ -197,30 +211,39 @@ export class GlobTool extends BaseTool<GlobToolParams, GlobToolResult> {
});
// 5. Format Output
- const sortedAbsolutePaths = entries.map(entry => entry.path);
+ const sortedAbsolutePaths = entries.map((entry) => entry.path);
// Convert absolute paths to relative paths (to rootDir) for clearer display
- const sortedRelativePaths = sortedAbsolutePaths.map(absPath => makeRelative(absPath, this.rootDirectory));
+ const sortedRelativePaths = sortedAbsolutePaths.map((absPath) =>
+ makeRelative(absPath, this.rootDirectory),
+ );
// Construct the result message
- const fileListDescription = sortedRelativePaths.map(p => ` - ${shortenPath(p)}`).join('\n');
+ const fileListDescription = sortedRelativePaths
+ .map((p) => ` - ${shortenPath(p)}`)
+ .join('\n');
const fileCount = sortedRelativePaths.length;
- const relativeSearchDir = makeRelative(searchDirAbsolute, this.rootDirectory);
- const displayPath = shortenPath(relativeSearchDir === '.' ? 'root directory' : relativeSearchDir);
+ const relativeSearchDir = makeRelative(
+ searchDirAbsolute,
+ this.rootDirectory,
+ );
+ const displayPath = shortenPath(
+ relativeSearchDir === '.' ? 'root directory' : relativeSearchDir,
+ );
return {
llmContent: `Found ${fileCount} file(s) matching "${params.pattern}" within ${displayPath}, sorted by modification time (newest first):\n${fileListDescription}`,
- returnDisplay: `Found ${fileCount} matching file(s)`
+ returnDisplay: `Found ${fileCount} matching file(s)`,
};
-
} catch (error) {
- // Catch unexpected errors during glob execution (less likely with suppressErrors=true, but possible)
- const errorMessage = error instanceof Error ? error.message : String(error);
- console.error(`GlobTool execute Error: ${errorMessage}`, error);
- return {
- llmContent: `Error during glob search operation: ${errorMessage}`,
- returnDisplay: `**Error:** An unexpected error occurred.`
- };
+ // Catch unexpected errors during glob execution (less likely with suppressErrors=true, but possible)
+ const errorMessage =
+ error instanceof Error ? error.message : String(error);
+ console.error(`GlobTool execute Error: ${errorMessage}`, error);
+ return {
+ llmContent: `Error during glob search operation: ${errorMessage}`,
+ returnDisplay: `**Error:** An unexpected error occurred.`,
+ };
}
}
-} \ No newline at end of file
+}
diff --git a/packages/cli/src/tools/grep.tool.ts b/packages/cli/src/tools/grep.tool.ts
index ed75890b..72e28d01 100644
--- a/packages/cli/src/tools/grep.tool.ts
+++ b/packages/cli/src/tools/grep.tool.ts
@@ -42,8 +42,7 @@ interface GrepMatch {
/**
* Result from the GrepTool
*/
-export interface GrepToolResult extends ToolResult {
-}
+export interface GrepToolResult extends ToolResult {}
// --- GrepTool Class ---
@@ -65,21 +64,24 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
{
properties: {
pattern: {
- description: 'The regular expression (regex) pattern to search for within file contents (e.g., \'function\\s+myFunction\', \'import\\s+\\{.*\\}\\s+from\\s+.*\').',
- type: 'string'
+ description:
+ "The regular expression (regex) pattern to search for within file contents (e.g., 'function\\s+myFunction', 'import\\s+\\{.*\\}\\s+from\\s+.*').",
+ type: 'string',
},
path: {
- description: 'Optional: The absolute path to the directory to search within. If omitted, searches the current working directory.',
- type: 'string'
+ description:
+ 'Optional: The absolute path to the directory to search within. If omitted, searches the current working directory.',
+ type: 'string',
},
include: {
- description: 'Optional: A glob pattern to filter which files are searched (e.g., \'*.js\', \'*.{ts,tsx}\', \'src/**\'). If omitted, searches all files (respecting potential global ignores).',
- type: 'string'
- }
+ description:
+ "Optional: A glob pattern to filter which files are searched (e.g., '*.js', '*.{ts,tsx}', 'src/**'). If omitted, searches all files (respecting potential global ignores).",
+ type: 'string',
+ },
},
required: ['pattern'],
- type: 'object'
- }
+ type: 'object',
+ },
);
// Ensure rootDirectory is absolute and normalized
this.rootDirectory = path.resolve(rootDirectory);
@@ -97,8 +99,13 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
const targetPath = path.resolve(this.rootDirectory, relativePath || '.');
// Security Check: Ensure the resolved path is still within the root directory.
- if (!targetPath.startsWith(this.rootDirectory) && targetPath !== this.rootDirectory) {
- throw new Error(`Path validation failed: Attempted path "${relativePath || '.'}" resolves outside the allowed root directory "${this.rootDirectory}".`);
+ if (
+ !targetPath.startsWith(this.rootDirectory) &&
+ targetPath !== this.rootDirectory
+ ) {
+ throw new Error(
+ `Path validation failed: Attempted path "${relativePath || '.'}" resolves outside the allowed root directory "${this.rootDirectory}".`,
+ );
}
// Check existence and type after resolving
@@ -111,7 +118,9 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
if (err.code === 'ENOENT') {
throw new Error(`Path does not exist: ${targetPath}`);
}
- throw new Error(`Failed to access path stats for ${targetPath}: ${err.message}`);
+ throw new Error(
+ `Failed to access path stats for ${targetPath}: ${err.message}`,
+ );
}
return targetPath;
@@ -123,8 +132,14 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
* @returns An error message string if invalid, null otherwise
*/
invalidParams(params: GrepToolParams): string | null {
- if (this.schema.parameters && !SchemaValidator.validate(this.schema.parameters as Record<string, unknown>, params)) {
- return "Parameters failed schema validation.";
+ if (
+ this.schema.parameters &&
+ !SchemaValidator.validate(
+ this.schema.parameters as Record<string, unknown>,
+ params,
+ )
+ ) {
+ return 'Parameters failed schema validation.';
}
try {
@@ -142,7 +157,6 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
return null; // Parameters are valid
}
-
// --- Core Execution ---
/**
@@ -156,7 +170,7 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
console.error(`GrepTool Parameter Validation Failed: ${validationError}`);
return {
llmContent: `Error: Invalid parameters provided. Reason: ${validationError}`,
- returnDisplay: `**Error:** Failed to execute tool.`
+ returnDisplay: `**Error:** Failed to execute tool.`,
};
}
@@ -177,40 +191,49 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
return { llmContent: noMatchMsg, returnDisplay: noMatchUser };
}
- const matchesByFile = matches.reduce((acc, match) => {
- const relativeFilePath = path.relative(searchDirAbs, path.resolve(searchDirAbs, match.filePath)) || path.basename(match.filePath);
- if (!acc[relativeFilePath]) {
- acc[relativeFilePath] = [];
- }
- acc[relativeFilePath].push(match);
- acc[relativeFilePath].sort((a, b) => a.lineNumber - b.lineNumber);
- return acc;
- }, {} as Record<string, GrepMatch[]>);
+ const matchesByFile = matches.reduce(
+ (acc, match) => {
+ const relativeFilePath =
+ path.relative(
+ searchDirAbs,
+ path.resolve(searchDirAbs, match.filePath),
+ ) || path.basename(match.filePath);
+ if (!acc[relativeFilePath]) {
+ acc[relativeFilePath] = [];
+ }
+ acc[relativeFilePath].push(match);
+ acc[relativeFilePath].sort((a, b) => a.lineNumber - b.lineNumber);
+ return acc;
+ },
+ {} as Record<string, GrepMatch[]>,
+ );
let llmContent = `Found ${matches.length} match(es) for pattern "${params.pattern}" in path "${searchDirDisplay}"${params.include ? ` (filter: "${params.include}")` : ''}:\n---\n`;
for (const filePath in matchesByFile) {
llmContent += `File: ${filePath}\n`;
- matchesByFile[filePath].forEach(match => {
+ matchesByFile[filePath].forEach((match) => {
const trimmedLine = match.line.trim();
llmContent += `L${match.lineNumber}: ${trimmedLine}\n`;
});
llmContent += '---\n';
}
- return { llmContent: llmContent.trim(), returnDisplay: `Found ${matches.length} matche(s)` };
-
+ return {
+ llmContent: llmContent.trim(),
+ returnDisplay: `Found ${matches.length} matche(s)`,
+ };
} catch (error) {
console.error(`Error during GrepTool execution: ${error}`);
- const errorMessage = error instanceof Error ? error.message : String(error);
+ const errorMessage =
+ error instanceof Error ? error.message : String(error);
return {
llmContent: `Error during grep search operation: ${errorMessage}`,
- returnDisplay: errorMessage
+ returnDisplay: errorMessage,
};
}
}
-
// --- Inlined Grep Logic and Helpers ---
/**
@@ -221,9 +244,13 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
private isCommandAvailable(command: string): Promise<boolean> {
return new Promise((resolve) => {
const checkCommand = process.platform === 'win32' ? 'where' : 'command';
- const checkArgs = process.platform === 'win32' ? [command] : ['-v', command];
+ const checkArgs =
+ process.platform === 'win32' ? [command] : ['-v', command];
try {
- const child = spawn(checkCommand, checkArgs, { stdio: 'ignore', shell: process.platform === 'win32' });
+ const child = spawn(checkCommand, checkArgs, {
+ stdio: 'ignore',
+ shell: process.platform === 'win32',
+ });
child.on('close', (code) => resolve(code === 0));
child.on('error', () => resolve(false));
} catch (e) {
@@ -252,7 +279,9 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
return false;
} catch (err: any) {
if (err.code !== 'ENOENT') {
- console.error(`Error checking for .git in ${currentPath}: ${err.message}`);
+ console.error(
+ `Error checking for .git in ${currentPath}: ${err.message}`,
+ );
return false;
}
}
@@ -263,19 +292,21 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
currentPath = path.dirname(currentPath);
}
} catch (err: any) {
- console.error(`Error traversing directory structure upwards from ${dirPath}: ${err instanceof Error ? err.message : String(err)}`);
+ console.error(
+ `Error traversing directory structure upwards from ${dirPath}: ${err instanceof Error ? err.message : String(err)}`,
+ );
}
return false;
}
/**
- * Parses the standard output of grep-like commands (git grep, system grep).
- * Expects format: filePath:lineNumber:lineContent
- * Handles colons within file paths and line content correctly.
- * @param {string} output The raw stdout string.
- * @param {string} basePath The absolute directory the search was run from, for relative paths.
- * @returns {GrepMatch[]} Array of match objects.
- */
+ * Parses the standard output of grep-like commands (git grep, system grep).
+ * Expects format: filePath:lineNumber:lineContent
+ * Handles colons within file paths and line content correctly.
+ * @param {string} output The raw stdout string.
+ * @param {string} basePath The absolute directory the search was run from, for relative paths.
+ * @returns {GrepMatch[]} Array of match objects.
+ */
private parseGrepOutput(output: string, basePath: string): GrepMatch[] {
const results: GrepMatch[] = [];
if (!output) return results;
@@ -302,7 +333,10 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
// Extract parts based on the found colon indices
const filePathRaw = line.substring(0, firstColonIndex);
- const lineNumberStr = line.substring(firstColonIndex + 1, secondColonIndex);
+ const lineNumberStr = line.substring(
+ firstColonIndex + 1,
+ secondColonIndex,
+ );
// The rest of the line, starting after the second colon, is the content.
const lineContent = line.substring(secondColonIndex + 1);
@@ -327,10 +361,10 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
}
/**
- * Gets a description of the grep operation
- * @param params Parameters for the grep operation
- * @returns A string describing the grep
- */
+ * Gets a description of the grep operation
+ * @param params Parameters for the grep operation
+ * @returns A string describing the grep
+ */
getDescription(params: GrepToolParams): string {
let description = `'${params.pattern}'`;
@@ -363,37 +397,59 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
try {
// --- Strategy 1: git grep ---
const isGit = await this.isGitRepository(absolutePath);
- const gitAvailable = isGit && await this.isCommandAvailable('git');
+ const gitAvailable = isGit && (await this.isCommandAvailable('git'));
if (gitAvailable) {
strategyUsed = 'git grep';
- const gitArgs = ['grep', '--untracked', '-n', '-E', '--ignore-case', pattern];
+ const gitArgs = [
+ 'grep',
+ '--untracked',
+ '-n',
+ '-E',
+ '--ignore-case',
+ pattern,
+ ];
if (include) {
gitArgs.push('--', include);
}
try {
const output = await new Promise<string>((resolve, reject) => {
- const child = spawn('git', gitArgs, { cwd: absolutePath, windowsHide: true });
+ const child = spawn('git', gitArgs, {
+ cwd: absolutePath,
+ windowsHide: true,
+ });
const stdoutChunks: Buffer[] = [];
const stderrChunks: Buffer[] = [];
- child.stdout.on('data', (chunk) => { stdoutChunks.push(chunk); });
- child.stderr.on('data', (chunk) => { stderrChunks.push(chunk); });
+ child.stdout.on('data', (chunk) => {
+ stdoutChunks.push(chunk);
+ });
+ child.stderr.on('data', (chunk) => {
+ stderrChunks.push(chunk);
+ });
- child.on('error', (err) => reject(new Error(`Failed to start git grep: ${err.message}`)));
+ child.on('error', (err) =>
+ reject(new Error(`Failed to start git grep: ${err.message}`)),
+ );
child.on('close', (code) => {
const stdoutData = Buffer.concat(stdoutChunks).toString('utf8');
const stderrData = Buffer.concat(stderrChunks).toString('utf8');
if (code === 0) resolve(stdoutData);
- else if (code === 1) resolve(''); // No matches is not an error
- else reject(new Error(`git grep exited with code ${code}: ${stderrData}`));
+ else if (code === 1)
+ resolve(''); // No matches is not an error
+ else
+ reject(
+ new Error(`git grep exited with code ${code}: ${stderrData}`),
+ );
});
});
return this.parseGrepOutput(output, absolutePath);
} catch (gitError: any) {
- console.error(`GrepTool: git grep strategy failed: ${gitError.message}. Falling back...`);
+ console.error(
+ `GrepTool: git grep strategy failed: ${gitError.message}. Falling back...`,
+ );
}
}
@@ -403,7 +459,7 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
strategyUsed = 'system grep';
const grepArgs = ['-r', '-n', '-H', '-E'];
const commonExcludes = ['.git', 'node_modules', 'bower_components'];
- commonExcludes.forEach(dir => grepArgs.push(`--exclude-dir=${dir}`));
+ commonExcludes.forEach((dir) => grepArgs.push(`--exclude-dir=${dir}`));
if (include) {
grepArgs.push(`--include=${include}`);
}
@@ -412,41 +468,67 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
try {
const output = await new Promise<string>((resolve, reject) => {
- const child = spawn('grep', grepArgs, { cwd: absolutePath, windowsHide: true });
+ const child = spawn('grep', grepArgs, {
+ cwd: absolutePath,
+ windowsHide: true,
+ });
const stdoutChunks: Buffer[] = [];
const stderrChunks: Buffer[] = [];
- child.stdout.on('data', (chunk) => { stdoutChunks.push(chunk); });
+ child.stdout.on('data', (chunk) => {
+ stdoutChunks.push(chunk);
+ });
child.stderr.on('data', (chunk) => {
const stderrStr = chunk.toString();
- if (!stderrStr.includes('Permission denied') && !/grep:.*: Is a directory/i.test(stderrStr)) {
+ if (
+ !stderrStr.includes('Permission denied') &&
+ !/grep:.*: Is a directory/i.test(stderrStr)
+ ) {
stderrChunks.push(chunk);
}
});
- child.on('error', (err) => reject(new Error(`Failed to start system grep: ${err.message}`)));
+ child.on('error', (err) =>
+ reject(new Error(`Failed to start system grep: ${err.message}`)),
+ );
child.on('close', (code) => {
const stdoutData = Buffer.concat(stdoutChunks).toString('utf8');
- const stderrData = Buffer.concat(stderrChunks).toString('utf8').trim();
+ const stderrData = Buffer.concat(stderrChunks)
+ .toString('utf8')
+ .trim();
if (code === 0) resolve(stdoutData);
- else if (code === 1) resolve(''); // No matches
+ else if (code === 1)
+ resolve(''); // No matches
else {
- if (stderrData) reject(new Error(`System grep exited with code ${code}: ${stderrData}`));
+ if (stderrData)
+ reject(
+ new Error(
+ `System grep exited with code ${code}: ${stderrData}`,
+ ),
+ );
else resolve('');
}
});
});
return this.parseGrepOutput(output, absolutePath);
} catch (grepError: any) {
- console.error(`GrepTool: System grep strategy failed: ${grepError.message}. Falling back...`);
+ console.error(
+ `GrepTool: System grep strategy failed: ${grepError.message}. Falling back...`,
+ );
}
}
// --- Strategy 3: Pure JavaScript Fallback ---
strategyUsed = 'javascript fallback';
const globPattern = include ? include : '**/*';
- const ignorePatterns = ['.git', 'node_modules', 'bower_components', '.svn', '.hg'];
+ const ignorePatterns = [
+ '.git',
+ 'node_modules',
+ 'bower_components',
+ '.svn',
+ '.hg',
+ ];
const filesStream = fastGlob.stream(globPattern, {
cwd: absolutePath,
@@ -469,7 +551,9 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
lines.forEach((line, index) => {
if (regex.test(line)) {
allMatches.push({
- filePath: path.relative(absolutePath, fileAbsolutePath) || path.basename(fileAbsolutePath),
+ filePath:
+ path.relative(absolutePath, fileAbsolutePath) ||
+ path.basename(fileAbsolutePath),
lineNumber: index + 1,
line: line,
});
@@ -477,16 +561,19 @@ export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
});
} catch (readError: any) {
if (readError.code !== 'ENOENT') {
- console.error(`GrepTool: Could not read or process file ${fileAbsolutePath}: ${readError.message}`);
+ console.error(
+ `GrepTool: Could not read or process file ${fileAbsolutePath}: ${readError.message}`,
+ );
}
}
}
return allMatches;
-
} catch (error: any) {
- console.error(`GrepTool: Error during performGrepSearch (Strategy: ${strategyUsed}): ${error.message}`);
+ console.error(
+ `GrepTool: Error during performGrepSearch (Strategy: ${strategyUsed}): ${error.message}`,
+ );
throw error; // Re-throw to be caught by the execute method's handler
}
}
-} \ No newline at end of file
+}
diff --git a/packages/cli/src/tools/ls.tool.ts b/packages/cli/src/tools/ls.tool.ts
index 6c4d5848..0a7ad2fa 100644
--- a/packages/cli/src/tools/ls.tool.ts
+++ b/packages/cli/src/tools/ls.tool.ts
@@ -91,20 +91,21 @@ export class LSTool extends BaseTool<LSToolParams, LSToolResult> {
{
properties: {
path: {
- description: 'The absolute path to the directory to list (must be absolute, not relative)',
- type: 'string'
+ description:
+ 'The absolute path to the directory to list (must be absolute, not relative)',
+ type: 'string',
},
ignore: {
description: 'List of glob patterns to ignore',
items: {
- type: 'string'
+ type: 'string',
},
- type: 'array'
- }
+ type: 'array',
+ },
},
required: ['path'],
- type: 'object'
- }
+ type: 'object',
+ },
);
// Set the root directory
@@ -123,7 +124,10 @@ export class LSTool extends BaseTool<LSToolParams, LSToolResult> {
const rootWithSep = normalizedRoot.endsWith(path.sep)
? normalizedRoot
: normalizedRoot + path.sep;
- return normalizedPath === normalizedRoot || normalizedPath.startsWith(rootWithSep);
+ return (
+ normalizedPath === normalizedRoot ||
+ normalizedPath.startsWith(rootWithSep)
+ );
}
/**
@@ -132,8 +136,14 @@ export class LSTool extends BaseTool<LSToolParams, LSToolResult> {
* @returns An error message string if invalid, null otherwise
*/
invalidParams(params: LSToolParams): string | null {
- if (this.schema.parameters && !SchemaValidator.validate(this.schema.parameters as Record<string, unknown>, params)) {
- return "Parameters failed schema validation.";
+ if (
+ this.schema.parameters &&
+ !SchemaValidator.validate(
+ this.schema.parameters as Record<string, unknown>,
+ params,
+ )
+ ) {
+ return 'Parameters failed schema validation.';
}
// Ensure path is absolute
if (!path.isAbsolute(params.path)) {
@@ -194,7 +204,7 @@ export class LSTool extends BaseTool<LSToolParams, LSToolResult> {
listedPath: params.path,
totalEntries: 0,
llmContent: `Error: Invalid parameters provided. Reason: ${validationError}`,
- returnDisplay: "**Error:** Failed to execute tool."
+ returnDisplay: '**Error:** Failed to execute tool.',
};
}
@@ -206,7 +216,7 @@ export class LSTool extends BaseTool<LSToolParams, LSToolResult> {
listedPath: params.path,
totalEntries: 0,
llmContent: `Directory does not exist: ${params.path}`,
- returnDisplay: `Directory does not exist`
+ returnDisplay: `Directory does not exist`,
};
}
// Check if path is a directory
@@ -217,7 +227,7 @@ export class LSTool extends BaseTool<LSToolParams, LSToolResult> {
listedPath: params.path,
totalEntries: 0,
llmContent: `Path is not a directory: ${params.path}`,
- returnDisplay: `Path is not a directory`
+ returnDisplay: `Path is not a directory`,
};
}
@@ -230,7 +240,7 @@ export class LSTool extends BaseTool<LSToolParams, LSToolResult> {
listedPath: params.path,
totalEntries: 0,
llmContent: `Directory is empty: ${params.path}`,
- returnDisplay: `Directory is empty.`
+ returnDisplay: `Directory is empty.`,
};
}
@@ -248,7 +258,7 @@ export class LSTool extends BaseTool<LSToolParams, LSToolResult> {
path: fullPath,
isDirectory: isDir,
size: isDir ? 0 : stats.size,
- modifiedTime: stats.mtime
+ modifiedTime: stats.mtime,
});
} catch (error) {
// Skip entries that can't be accessed
@@ -264,18 +274,20 @@ export class LSTool extends BaseTool<LSToolParams, LSToolResult> {
});
// Create formatted content for display
- const directoryContent = entries.map(entry => {
- const typeIndicator = entry.isDirectory ? 'd' : '-';
- const sizeInfo = entry.isDirectory ? '' : ` (${entry.size} bytes)`;
- return `${typeIndicator} ${entry.name}${sizeInfo}`;
- }).join('\n');
-
+ const directoryContent = entries
+ .map((entry) => {
+ const typeIndicator = entry.isDirectory ? 'd' : '-';
+ const sizeInfo = entry.isDirectory ? '' : ` (${entry.size} bytes)`;
+ return `${typeIndicator} ${entry.name}${sizeInfo}`;
+ })
+ .join('\n');
+
return {
entries,
listedPath: params.path,
totalEntries: entries.length,
llmContent: `Directory listing for ${params.path}:\n${directoryContent}`,
- returnDisplay: `Found ${entries.length} item(s).`
+ returnDisplay: `Found ${entries.length} item(s).`,
};
} catch (error) {
const errorMessage = `Error listing directory: ${error instanceof Error ? error.message : String(error)}`;
@@ -284,8 +296,8 @@ export class LSTool extends BaseTool<LSToolParams, LSToolResult> {
listedPath: params.path,
totalEntries: 0,
llmContent: errorMessage,
- returnDisplay: `**Error:** ${errorMessage}`
+ returnDisplay: `**Error:** ${errorMessage}`,
};
}
}
-} \ No newline at end of file
+}
diff --git a/packages/cli/src/tools/read-file.tool.ts b/packages/cli/src/tools/read-file.tool.ts
index 7cca3391..fc4dc977 100644
--- a/packages/cli/src/tools/read-file.tool.ts
+++ b/packages/cli/src/tools/read-file.tool.ts
@@ -27,13 +27,15 @@ export interface ReadFileToolParams {
/**
* Standardized result from the ReadFile tool
*/
-export interface ReadFileToolResult extends ToolResult {
-}
+export interface ReadFileToolResult extends ToolResult {}
/**
* Implementation of the ReadFile tool that reads files from the filesystem
*/
-export class ReadFileTool extends BaseTool<ReadFileToolParams, ReadFileToolResult> {
+export class ReadFileTool extends BaseTool<
+ ReadFileToolParams,
+ ReadFileToolResult
+> {
public static readonly Name: string = 'read_file';
// Maximum number of lines to read by default
@@ -60,21 +62,24 @@ export class ReadFileTool extends BaseTool<ReadFileToolParams, ReadFileToolResul
{
properties: {
file_path: {
- description: 'The absolute path to the file to read (e.g., \'/home/user/project/file.txt\'). Relative paths are not supported.',
- type: 'string'
+ description:
+ "The absolute path to the file to read (e.g., '/home/user/project/file.txt'). Relative paths are not supported.",
+ type: 'string',
},
offset: {
- description: 'Optional: The 0-based line number to start reading from. Requires \'limit\' to be set. Use for paginating through large files.',
- type: 'number'
+ description:
+ "Optional: The 0-based line number to start reading from. Requires 'limit' to be set. Use for paginating through large files.",
+ type: 'number',
},
limit: {
- description: 'Optional: Maximum number of lines to read. Use with \'offset\' to paginate through large files. If omitted, reads the entire file (if feasible).',
- type: 'number'
- }
+ description:
+ "Optional: Maximum number of lines to read. Use with 'offset' to paginate through large files. If omitted, reads the entire file (if feasible).",
+ type: 'number',
+ },
},
required: ['file_path'],
- type: 'object'
- }
+ type: 'object',
+ },
);
// Set the root directory
@@ -95,7 +100,10 @@ export class ReadFileTool extends BaseTool<ReadFileToolParams, ReadFileToolResul
? normalizedRoot
: normalizedRoot + path.sep;
- return normalizedPath === normalizedRoot || normalizedPath.startsWith(rootWithSep);
+ return (
+ normalizedPath === normalizedRoot ||
+ normalizedPath.startsWith(rootWithSep)
+ );
}
/**
@@ -104,8 +112,14 @@ export class ReadFileTool extends BaseTool<ReadFileToolParams, ReadFileToolResul
* @returns True if parameters are valid, false otherwise
*/
invalidParams(params: ReadFileToolParams): string | null {
- if (this.schema.parameters && !SchemaValidator.validate(this.schema.parameters as Record<string, unknown>, params)) {
- return "Parameters failed schema validation.";
+ if (
+ this.schema.parameters &&
+ !SchemaValidator.validate(
+ this.schema.parameters as Record<string, unknown>,
+ params,
+ )
+ ) {
+ return 'Parameters failed schema validation.';
}
const filePath = params.file_path;
if (!path.isAbsolute(filePath)) {
@@ -151,7 +165,7 @@ export class ReadFileTool extends BaseTool<ReadFileToolParams, ReadFileToolResul
}
// If more than 30% are non-printable, likely binary
- return (nonPrintableCount / bytesRead) > 0.3;
+ return nonPrintableCount / bytesRead > 0.3;
} catch (error) {
return false;
}
@@ -166,7 +180,9 @@ export class ReadFileTool extends BaseTool<ReadFileToolParams, ReadFileToolResul
const ext = path.extname(filePath).toLowerCase();
// Common image formats
- if (['.jpg', '.jpeg', '.png', '.gif', '.bmp', '.webp', '.svg'].includes(ext)) {
+ if (
+ ['.jpg', '.jpeg', '.png', '.gif', '.bmp', '.webp', '.svg'].includes(ext)
+ ) {
return 'image';
}
@@ -189,8 +205,8 @@ export class ReadFileTool extends BaseTool<ReadFileToolParams, ReadFileToolResul
* @returns A string describing the file being read
*/
getDescription(params: ReadFileToolParams): string {
- const relativePath = makeRelative(params.file_path, this.rootDirectory);
- return shortenPath(relativePath);
+ const relativePath = makeRelative(params.file_path, this.rootDirectory);
+ return shortenPath(relativePath);
}
/**
@@ -204,7 +220,7 @@ export class ReadFileTool extends BaseTool<ReadFileToolParams, ReadFileToolResul
if (validationError) {
return {
llmContent: `Error: Invalid parameters provided. Reason: ${validationError}`,
- returnDisplay: "**Error:** Failed to execute tool."
+ returnDisplay: '**Error:** Failed to execute tool.',
};
}
@@ -245,14 +261,15 @@ export class ReadFileTool extends BaseTool<ReadFileToolParams, ReadFileToolResul
const formattedLines = selectedLines.map((line) => {
let processedLine = line;
if (line.length > ReadFileTool.MAX_LINE_LENGTH) {
- processedLine = line.substring(0, ReadFileTool.MAX_LINE_LENGTH) + '... [truncated]';
+ processedLine =
+ line.substring(0, ReadFileTool.MAX_LINE_LENGTH) + '... [truncated]';
truncated = true;
}
return processedLine;
});
- const contentTruncated = (endLine < lines.length) || truncated;
+ const contentTruncated = endLine < lines.length || truncated;
let llmContent = '';
if (contentTruncated) {
@@ -273,4 +290,4 @@ export class ReadFileTool extends BaseTool<ReadFileToolParams, ReadFileToolResul
};
}
}
-} \ No newline at end of file
+}
diff --git a/packages/cli/src/tools/terminal.tool.ts b/packages/cli/src/tools/terminal.tool.ts
index eef9b7d4..a51f8e6b 100644
--- a/packages/cli/src/tools/terminal.tool.ts
+++ b/packages/cli/src/tools/terminal.tool.ts
@@ -1,26 +1,35 @@
-import { spawn, SpawnOptions, ChildProcessWithoutNullStreams, exec } from 'child_process'; // Added 'exec'
+import {
+ spawn,
+ SpawnOptions,
+ ChildProcessWithoutNullStreams,
+ exec,
+} from 'child_process'; // Added 'exec'
import path from 'path';
import os from 'os';
import crypto from 'crypto';
import { promises as fs } from 'fs';
import { BaseTool, ToolResult } from './tools.js';
import { SchemaValidator } from '../utils/schemaValidator.js';
-import { ToolCallConfirmationDetails, ToolConfirmationOutcome, ToolExecuteConfirmationDetails } from '../ui/types.js'; // Adjust path as needed
+import {
+ ToolCallConfirmationDetails,
+ ToolConfirmationOutcome,
+ ToolExecuteConfirmationDetails,
+} from '../ui/types.js'; // Adjust path as needed
import { BackgroundTerminalAnalyzer } from '../utils/BackgroundTerminalAnalyzer.js';
// --- Interfaces ---
export interface TerminalToolParams {
- command: string;
- description?: string;
- timeout?: number;
- runInBackground?: boolean;
+ command: string;
+ description?: string;
+ timeout?: number;
+ runInBackground?: boolean;
}
export interface TerminalToolResult extends ToolResult {
- // Add specific fields if needed for structured output from polling/LLM
- // finalStdout?: string;
- // finalStderr?: string;
- // llmAnalysis?: string;
+ // Add specific fields if needed for structured output from polling/LLM
+ // finalStdout?: string;
+ // finalStderr?: string;
+ // llmAnalysis?: string;
}
// --- Constants ---
@@ -32,54 +41,112 @@ const BACKGROUND_POLL_INTERVAL_MS = 5000; // 5 seconds interval for checking bac
const BACKGROUND_POLL_TIMEOUT_MS = 30000; // 30 seconds total polling time for background process status
const BANNED_COMMAND_ROOTS = [
- // Session/flow control (excluding cd)
- 'alias', 'bg', 'command', 'declare', 'dirs', 'disown', 'enable', 'eval', 'exec',
- 'exit', 'export', 'fc', 'fg', 'getopts', 'hash', 'history', 'jobs', 'kill', 'let',
- 'local', 'logout', 'popd', 'printf', 'pushd', /* 'pwd' is safe */ 'read', 'readonly', 'set',
- 'shift', 'shopt', 'source', 'suspend', 'test', 'times', 'trap', 'type', 'typeset',
- 'ulimit', 'umask', 'unalias', 'unset', 'wait',
- // Network commands
- 'curl', 'wget', 'nc', 'telnet', 'ssh', 'scp', 'ftp', 'sftp',
- 'http', 'https', 'ftp', 'rsync',
- // Browsers/GUI launchers
- 'lynx', 'w3m', 'links', 'elinks', 'httpie', 'xh', 'http-prompt',
- 'chrome', 'firefox', 'safari', 'edge', 'xdg-open', 'open'
+ // Session/flow control (excluding cd)
+ 'alias',
+ 'bg',
+ 'command',
+ 'declare',
+ 'dirs',
+ 'disown',
+ 'enable',
+ 'eval',
+ 'exec',
+ 'exit',
+ 'export',
+ 'fc',
+ 'fg',
+ 'getopts',
+ 'hash',
+ 'history',
+ 'jobs',
+ 'kill',
+ 'let',
+ 'local',
+ 'logout',
+ 'popd',
+ 'printf',
+ 'pushd',
+ /* 'pwd' is safe */ 'read',
+ 'readonly',
+ 'set',
+ 'shift',
+ 'shopt',
+ 'source',
+ 'suspend',
+ 'test',
+ 'times',
+ 'trap',
+ 'type',
+ 'typeset',
+ 'ulimit',
+ 'umask',
+ 'unalias',
+ 'unset',
+ 'wait',
+ // Network commands
+ 'curl',
+ 'wget',
+ 'nc',
+ 'telnet',
+ 'ssh',
+ 'scp',
+ 'ftp',
+ 'sftp',
+ 'http',
+ 'https',
+ 'ftp',
+ 'rsync',
+ // Browsers/GUI launchers
+ 'lynx',
+ 'w3m',
+ 'links',
+ 'elinks',
+ 'httpie',
+ 'xh',
+ 'http-prompt',
+ 'chrome',
+ 'firefox',
+ 'safari',
+ 'edge',
+ 'xdg-open',
+ 'open',
];
-
// --- Helper Type for Command Queue ---
interface QueuedCommand {
- params: TerminalToolParams;
- resolve: (result: TerminalToolResult) => void;
- reject: (error: Error) => void;
- confirmationDetails: ToolExecuteConfirmationDetails | false; // Kept for potential future use
+ params: TerminalToolParams;
+ resolve: (result: TerminalToolResult) => void;
+ reject: (error: Error) => void;
+ confirmationDetails: ToolExecuteConfirmationDetails | false; // Kept for potential future use
}
/**
* Implementation of the terminal tool that executes shell commands within a persistent session.
*/
-export class TerminalTool extends BaseTool<TerminalToolParams, TerminalToolResult> {
- public static Name: string = 'execute_bash_command';
-
- private readonly rootDirectory: string;
- private readonly outputLimit: number;
- private bashProcess: ChildProcessWithoutNullStreams | null = null;
- private currentCwd: string;
- private isExecuting: boolean = false;
- private commandQueue: QueuedCommand[] = [];
- private currentCommandCleanup: (() => void) | null = null;
- private shouldAlwaysExecuteCommands: Map<string, boolean> = new Map(); // Track confirmation per root command
- private shellReady: Promise<void>;
- private resolveShellReady: (() => void) | undefined; // Definite assignment assertion
- private rejectShellReady: ((reason?: any) => void) | undefined; // Definite assignment assertion
- private readonly backgroundTerminalAnalyzer: BackgroundTerminalAnalyzer;
+export class TerminalTool extends BaseTool<
+ TerminalToolParams,
+ TerminalToolResult
+> {
+ public static Name: string = 'execute_bash_command';
+ private readonly rootDirectory: string;
+ private readonly outputLimit: number;
+ private bashProcess: ChildProcessWithoutNullStreams | null = null;
+ private currentCwd: string;
+ private isExecuting: boolean = false;
+ private commandQueue: QueuedCommand[] = [];
+ private currentCommandCleanup: (() => void) | null = null;
+ private shouldAlwaysExecuteCommands: Map<string, boolean> = new Map(); // Track confirmation per root command
+ private shellReady: Promise<void>;
+ private resolveShellReady: (() => void) | undefined; // Definite assignment assertion
+ private rejectShellReady: ((reason?: any) => void) | undefined; // Definite assignment assertion
+ private readonly backgroundTerminalAnalyzer: BackgroundTerminalAnalyzer;
- constructor(rootDirectory: string, outputLimit: number = MAX_OUTPUT_LENGTH) {
- const toolDisplayName = 'Terminal';
- // --- LLM-Facing Description ---
- // Updated description for background tasks to mention polling and LLM analysis
- const toolDescription = `Executes one or more bash commands sequentially in a secure and persistent interactive shell session. Can run commands in the foreground (waiting for completion) or background (returning after launch, with subsequent status polling).
+ constructor(rootDirectory: string, outputLimit: number = MAX_OUTPUT_LENGTH) {
+ const toolDisplayName = 'Terminal';
+ // --- LLM-Facing Description ---
+ // Updated description for background tasks to mention polling and LLM analysis
+ const toolDescription = `Executes one or more bash commands sequentially in a secure and persistent interactive shell session. Can run commands in the foreground (waiting for completion) or background (returning after launch, with subsequent status polling).
Core Functionality:
* Starts in project root: '${path.basename(rootDirectory)}'. Current Directory starts as: ${rootDirectory} (will update based on 'cd' commands).
@@ -101,7 +168,7 @@ Usage Guidance & Restrictions:
* Do NOT use this tool for listing files (\`ls\`). Use the dedicated File System tool ('list_directory') instead. Relying on this tool's output for directory structure is unreliable due to potential truncation and lack of structured data.
3. **Security & Banned Commands:**
- * Certain commands are banned for security (e.g., network: ${BANNED_COMMAND_ROOTS.filter(c => ['curl', 'wget', 'ssh'].includes(c)).join(', ')}; session: ${BANNED_COMMAND_ROOTS.filter(c => ['exit', 'export', 'kill'].includes(c)).join(', ')}; etc.). The full list is extensive.
+ * Certain commands are banned for security (e.g., network: ${BANNED_COMMAND_ROOTS.filter((c) => ['curl', 'wget', 'ssh'].includes(c)).join(', ')}; session: ${BANNED_COMMAND_ROOTS.filter((c) => ['exit', 'export', 'kill'].includes(c)).join(', ')}; etc.). The full list is extensive.
* If you attempt a banned command, this tool will return an error explaining the restriction. You MUST relay this error clearly to the user.
4. **Command Execution Notes:**
@@ -120,838 +187,1023 @@ Usage Guidance & Restrictions:
* The initial exit code (usually 0) signifies successful *launching*; the final status indicates completion or timeout after polling.
Use this tool for running build steps (\`npm install\`, \`make\`), linters (\`eslint .\`), test runners (\`pytest\`, \`jest\`), code formatters (\`prettier --write .\`), package managers (\`pip install\`), version control operations (\`git status\`, \`git diff\`), starting background servers/services (\`node server.js --runInBackground true\`), or other safe, standard command-line operations within the project workspace.`;
- // --- Parameter Schema ---
- const toolParameterSchema = {
- type: 'object',
- properties: {
- command: {
- description: `The exact bash command or sequence of commands (using ';' or '&&') to execute. Must adhere to usage guidelines. Example: 'npm install && npm run build'`,
- type: 'string'
- },
- description: {
- description: `Optional: A brief, user-centric explanation of what the command does and why it's being run. Used for logging and confirmation prompts. Example: 'Install project dependencies'`,
- type: 'string'
- },
- timeout: {
- description: `Optional execution time limit in milliseconds for FOREGROUND commands. Max ${MAX_TIMEOUT_OVERRIDE_MS}ms (${MAX_TIMEOUT_OVERRIDE_MS / 60000} min). Defaults to ${DEFAULT_TIMEOUT_MS}ms (${DEFAULT_TIMEOUT_MS / 60000} min) if not specified or invalid. Ignored if 'runInBackground' is true.`,
- type: 'number'
- },
- runInBackground: {
- description: `If true, execute the command in the background using '&'. Defaults to false. Use for servers or long tasks.`,
- type: 'boolean',
- }
- },
- required: ['command']
- };
+ // --- Parameter Schema ---
+ const toolParameterSchema = {
+ type: 'object',
+ properties: {
+ command: {
+ description: `The exact bash command or sequence of commands (using ';' or '&&') to execute. Must adhere to usage guidelines. Example: 'npm install && npm run build'`,
+ type: 'string',
+ },
+ description: {
+ description: `Optional: A brief, user-centric explanation of what the command does and why it's being run. Used for logging and confirmation prompts. Example: 'Install project dependencies'`,
+ type: 'string',
+ },
+ timeout: {
+ description: `Optional execution time limit in milliseconds for FOREGROUND commands. Max ${MAX_TIMEOUT_OVERRIDE_MS}ms (${MAX_TIMEOUT_OVERRIDE_MS / 60000} min). Defaults to ${DEFAULT_TIMEOUT_MS}ms (${DEFAULT_TIMEOUT_MS / 60000} min) if not specified or invalid. Ignored if 'runInBackground' is true.`,
+ type: 'number',
+ },
+ runInBackground: {
+ description: `If true, execute the command in the background using '&'. Defaults to false. Use for servers or long tasks.`,
+ type: 'boolean',
+ },
+ },
+ required: ['command'],
+ };
+ super(
+ TerminalTool.Name,
+ toolDisplayName,
+ toolDescription,
+ toolParameterSchema,
+ );
- super(
- TerminalTool.Name,
- toolDisplayName,
- toolDescription,
- toolParameterSchema
- );
+ this.rootDirectory = path.resolve(rootDirectory);
+ this.currentCwd = this.rootDirectory;
+ this.outputLimit = outputLimit;
+ this.shellReady = new Promise((resolve, reject) => {
+ this.resolveShellReady = resolve;
+ this.rejectShellReady = reject;
+ });
+ this.backgroundTerminalAnalyzer = new BackgroundTerminalAnalyzer();
- this.rootDirectory = path.resolve(rootDirectory);
- this.currentCwd = this.rootDirectory;
- this.outputLimit = outputLimit;
- this.shellReady = new Promise((resolve, reject) => {
- this.resolveShellReady = resolve;
- this.rejectShellReady = reject;
- });
- this.backgroundTerminalAnalyzer = new BackgroundTerminalAnalyzer();
+ this.initializeShell();
+ }
- this.initializeShell();
+ // --- Shell Initialization and Management (largely unchanged) ---
+ private initializeShell() {
+ if (this.bashProcess) {
+ try {
+ this.bashProcess.kill();
+ } catch (e) {
+ /* Ignore */
+ }
}
- // --- Shell Initialization and Management (largely unchanged) ---
- private initializeShell() {
- if (this.bashProcess) {
- try {
- this.bashProcess.kill();
- } catch (e) { /* Ignore */ }
- }
+ const spawnOptions: SpawnOptions = {
+ cwd: this.rootDirectory,
+ shell: true,
+ env: { ...process.env },
+ stdio: ['pipe', 'pipe', 'pipe'],
+ };
- const spawnOptions: SpawnOptions = {
- cwd: this.rootDirectory,
- shell: true,
- env: { ...process.env },
- stdio: ['pipe', 'pipe', 'pipe']
- };
+ try {
+ const bashPath = os.platform() === 'win32' ? 'bash.exe' : 'bash';
+ this.bashProcess = spawn(
+ bashPath,
+ ['-s'],
+ spawnOptions,
+ ) as ChildProcessWithoutNullStreams;
+ this.currentCwd = this.rootDirectory; // Reset CWD on restart
- try {
- const bashPath = os.platform() === 'win32' ? 'bash.exe' : 'bash';
- this.bashProcess = spawn(bashPath, ['-s'], spawnOptions) as ChildProcessWithoutNullStreams;
- this.currentCwd = this.rootDirectory; // Reset CWD on restart
+ this.bashProcess.on('error', (err) => {
+ console.error('Persistent Bash Error:', err);
+ this.rejectShellReady?.(err); // Use optional chaining as reject might be cleared
+ this.bashProcess = null;
+ this.isExecuting = false;
+ this.clearQueue(
+ new Error(`Persistent bash process failed to start: ${err.message}`),
+ );
+ });
- this.bashProcess.on('error', (err) => {
- console.error('Persistent Bash Error:', err);
- this.rejectShellReady?.(err); // Use optional chaining as reject might be cleared
- this.bashProcess = null;
- this.isExecuting = false;
- this.clearQueue(new Error(`Persistent bash process failed to start: ${err.message}`));
- });
+ this.bashProcess.on('close', (code, signal) => {
+ this.bashProcess = null;
+ this.isExecuting = false;
+ // Only reject if it hasn't been resolved/rejected already
+ this.rejectShellReady?.(
+ new Error(
+ `Persistent bash process exited (code: ${code}, signal: ${signal})`,
+ ),
+ );
+ // Reset shell readiness promise for reinitialization attempts
+ this.shellReady = new Promise((resolve, reject) => {
+ this.resolveShellReady = resolve;
+ this.rejectShellReady = reject;
+ });
+ this.clearQueue(
+ new Error(
+ `Persistent bash process exited unexpectedly (code: ${code}, signal: ${signal}). State is lost. Queued commands cancelled.`,
+ ),
+ );
+ // Attempt to reinitialize after a short delay
+ setTimeout(() => this.initializeShell(), 1000);
+ });
- this.bashProcess.on('close', (code, signal) => {
- this.bashProcess = null;
- this.isExecuting = false;
- // Only reject if it hasn't been resolved/rejected already
- this.rejectShellReady?.(new Error(`Persistent bash process exited (code: ${code}, signal: ${signal})`));
- // Reset shell readiness promise for reinitialization attempts
- this.shellReady = new Promise((resolve, reject) => {
- this.resolveShellReady = resolve;
- this.rejectShellReady = reject;
- });
- this.clearQueue(new Error(`Persistent bash process exited unexpectedly (code: ${code}, signal: ${signal}). State is lost. Queued commands cancelled.`));
- // Attempt to reinitialize after a short delay
- setTimeout(() => this.initializeShell(), 1000);
- });
+ // Readiness check - ensure shell is responsive
+ // Slightly longer timeout to allow shell init
+ setTimeout(() => {
+ if (this.bashProcess && !this.bashProcess.killed) {
+ this.resolveShellReady?.(); // Use optional chaining
+ } else if (!this.bashProcess) {
+ // Error likely already handled by 'error' or 'close' event
+ } else {
+ // Process was killed during init?
+ this.rejectShellReady?.(
+ new Error('Shell killed during initialization'),
+ );
+ }
+ }, 1000); // Increase readiness check timeout slightly
+ } catch (error: any) {
+ console.error('Failed to spawn persistent bash:', error);
+ this.rejectShellReady?.(error); // Use optional chaining
+ this.bashProcess = null;
+ this.clearQueue(
+ new Error(`Failed to spawn persistent bash: ${error.message}`),
+ );
+ }
+ }
- // Readiness check - ensure shell is responsive
- // Slightly longer timeout to allow shell init
- setTimeout(() => {
- if (this.bashProcess && !this.bashProcess.killed) {
- this.resolveShellReady?.(); // Use optional chaining
- } else if (!this.bashProcess) {
- // Error likely already handled by 'error' or 'close' event
- } else {
- // Process was killed during init?
- this.rejectShellReady?.(new Error("Shell killed during initialization"));
- }
- }, 1000); // Increase readiness check timeout slightly
+ // --- Parameter Validation (unchanged) ---
+ invalidParams(params: TerminalToolParams): string | null {
+ if (
+ !SchemaValidator.validate(
+ this.parameterSchema as Record<string, unknown>,
+ params,
+ )
+ ) {
+ return `Parameters failed schema validation.`;
+ }
- } catch (error: any) {
- console.error("Failed to spawn persistent bash:", error);
- this.rejectShellReady?.(error); // Use optional chaining
- this.bashProcess = null;
- this.clearQueue(new Error(`Failed to spawn persistent bash: ${error.message}`));
- }
+ const commandOriginal = params.command.trim();
+ if (!commandOriginal) {
+ return 'Command cannot be empty.';
}
+ const commandLower = commandOriginal.toLowerCase();
+ const commandParts = commandOriginal.split(/[\s;&&|]+/);
- // --- Parameter Validation (unchanged) ---
- invalidParams(params: TerminalToolParams): string | null {
- if (!SchemaValidator.validate(this.parameterSchema as Record<string, unknown>, params)) {
- return `Parameters failed schema validation.`;
- }
+ for (const part of commandParts) {
+ if (!part) continue;
+ // Improved check: strip leading special chars before checking basename
+ const cleanPart =
+ part
+ .replace(/^[^a-zA-Z0-9]+/, '')
+ .split(/[\/\\]/)
+ .pop() || part.replace(/^[^a-zA-Z0-9]+/, '');
+ if (cleanPart && BANNED_COMMAND_ROOTS.includes(cleanPart.toLowerCase())) {
+ return `Command contains a banned keyword: '${cleanPart}'. Banned list includes network tools, session control, etc.`;
+ }
+ }
- const commandOriginal = params.command.trim();
- if (!commandOriginal) {
- return "Command cannot be empty.";
- }
- const commandLower = commandOriginal.toLowerCase();
- const commandParts = commandOriginal.split(/[\s;&&|]+/);
+ if (
+ params.timeout !== undefined &&
+ (typeof params.timeout !== 'number' || params.timeout <= 0)
+ ) {
+ return 'Timeout must be a positive number of milliseconds.';
+ }
- for (const part of commandParts) {
- if (!part) continue;
- // Improved check: strip leading special chars before checking basename
- const cleanPart = part.replace(/^[^a-zA-Z0-9]+/, '').split(/[\/\\]/).pop() || part.replace(/^[^a-zA-Z0-9]+/, '');
- if (cleanPart && BANNED_COMMAND_ROOTS.includes(cleanPart.toLowerCase())) {
- return `Command contains a banned keyword: '${cleanPart}'. Banned list includes network tools, session control, etc.`;
- }
- }
+ // Relax the absolute path restriction slightly if needed, but generally good practice
+ // const firstCommandPart = commandParts[0];
+ // if (firstCommandPart && (firstCommandPart.startsWith('/') || firstCommandPart.startsWith('\\'))) {
+ // return 'Executing commands via absolute paths (starting with \'/\' or \'\\\') is restricted. Use commands available in PATH or relative paths.';
+ // }
- if (params.timeout !== undefined && (typeof params.timeout !== 'number' || params.timeout <= 0)) {
- return 'Timeout must be a positive number of milliseconds.';
- }
+ return null; // Parameters are valid
+ }
- // Relax the absolute path restriction slightly if needed, but generally good practice
- // const firstCommandPart = commandParts[0];
- // if (firstCommandPart && (firstCommandPart.startsWith('/') || firstCommandPart.startsWith('\\'))) {
- // return 'Executing commands via absolute paths (starting with \'/\' or \'\\\') is restricted. Use commands available in PATH or relative paths.';
- // }
+ // --- Description and Confirmation (unchanged) ---
+ getDescription(params: TerminalToolParams): string {
+ return params.description || params.command;
+ }
- return null; // Parameters are valid
- }
+ async shouldConfirmExecute(
+ params: TerminalToolParams,
+ ): Promise<ToolCallConfirmationDetails | false> {
+ const rootCommand =
+ params.command
+ .trim()
+ .split(/[\s;&&|]+/)[0]
+ ?.split(/[\/\\]/)
+ .pop() || 'unknown';
- // --- Description and Confirmation (unchanged) ---
- getDescription(params: TerminalToolParams): string {
- return params.description || params.command;
+ if (this.shouldAlwaysExecuteCommands.get(rootCommand)) {
+ return false;
}
- async shouldConfirmExecute(params: TerminalToolParams): Promise<ToolCallConfirmationDetails | false> {
- const rootCommand = params.command.trim().split(/[\s;&&|]+/)[0]?.split(/[\/\\]/).pop() || 'unknown';
+ const description = this.getDescription(params);
- if (this.shouldAlwaysExecuteCommands.get(rootCommand)) {
- return false;
+ const confirmationDetails: ToolExecuteConfirmationDetails = {
+ title: 'Confirm Shell Command',
+ command: params.command,
+ rootCommand: rootCommand,
+ description: `Execute in '${this.currentCwd}':\n${description}`,
+ onConfirm: async (outcome: ToolConfirmationOutcome) => {
+ if (outcome === ToolConfirmationOutcome.ProceedAlways) {
+ this.shouldAlwaysExecuteCommands.set(rootCommand, true);
}
+ },
+ };
+ return confirmationDetails;
+ }
- const description = this.getDescription(params);
-
- const confirmationDetails: ToolExecuteConfirmationDetails = {
- title: 'Confirm Shell Command',
- command: params.command,
- rootCommand: rootCommand,
- description: `Execute in '${this.currentCwd}':\n${description}`,
- onConfirm: async (outcome: ToolConfirmationOutcome) => {
- if (outcome === ToolConfirmationOutcome.ProceedAlways) {
- this.shouldAlwaysExecuteCommands.set(rootCommand, true);
- }
- },
- };
- return confirmationDetails;
+ // --- Command Execution and Queueing (unchanged structure) ---
+ async execute(params: TerminalToolParams): Promise<TerminalToolResult> {
+ const validationError = this.invalidParams(params);
+ if (validationError) {
+ return {
+ llmContent: `Command rejected: ${params.command}\nReason: ${validationError}`,
+ returnDisplay: `Error: ${validationError}`,
+ };
}
- // --- Command Execution and Queueing (unchanged structure) ---
- async execute(params: TerminalToolParams): Promise<TerminalToolResult> {
- const validationError = this.invalidParams(params);
- if (validationError) {
- return {
- llmContent: `Command rejected: ${params.command}\nReason: ${validationError}`,
- returnDisplay: `Error: ${validationError}`,
- };
- }
+ // Assume confirmation is handled before calling execute
- // Assume confirmation is handled before calling execute
+ return new Promise((resolve) => {
+ const queuedItem: QueuedCommand = {
+ params,
+ resolve, // Resolve outer promise
+ reject: (error) =>
+ resolve({
+ // Handle internal errors by resolving outer promise
+ llmContent: `Internal tool error for command: ${params.command}\nError: ${error.message}`,
+ returnDisplay: `Internal Tool Error: ${error.message}`,
+ }),
+ confirmationDetails: false, // Placeholder
+ };
+ this.commandQueue.push(queuedItem);
+ // Ensure queue processing is triggered *after* adding the item
+ setImmediate(() => this.triggerQueueProcessing());
+ });
+ }
- return new Promise((resolve) => {
- const queuedItem: QueuedCommand = {
- params,
- resolve, // Resolve outer promise
- reject: (error) => resolve({ // Handle internal errors by resolving outer promise
- llmContent: `Internal tool error for command: ${params.command}\nError: ${error.message}`,
- returnDisplay: `Internal Tool Error: ${error.message}`
- }),
- confirmationDetails: false // Placeholder
- };
- this.commandQueue.push(queuedItem);
- // Ensure queue processing is triggered *after* adding the item
- setImmediate(() => this.triggerQueueProcessing());
- });
+ private async triggerQueueProcessing(): Promise<void> {
+ if (this.isExecuting || this.commandQueue.length === 0) {
+ return;
}
- private async triggerQueueProcessing(): Promise<void> {
- if (this.isExecuting || this.commandQueue.length === 0) {
- return;
- }
-
- this.isExecuting = true;
- const { params, resolve, reject } = this.commandQueue.shift()!;
+ this.isExecuting = true;
+ const { params, resolve, reject } = this.commandQueue.shift()!;
- try {
- await this.shellReady; // Wait for the shell to be ready (or reinitialized)
- if (!this.bashProcess || this.bashProcess.killed) { // Check if killed
- throw new Error("Persistent bash process is not available or was killed.");
- }
- // **** Core execution logic call ****
- const result = await this.executeCommandInShell(params);
- resolve(result); // Resolve the specific command's promise
- } catch (error: any) {
- console.error(`Error executing command "${params.command}":`, error);
- reject(error); // Use the specific command's reject handler
- } finally {
- this.isExecuting = false;
- // Use setImmediate to avoid potential deep recursion
- setImmediate(() => this.triggerQueueProcessing());
- }
+ try {
+ await this.shellReady; // Wait for the shell to be ready (or reinitialized)
+ if (!this.bashProcess || this.bashProcess.killed) {
+ // Check if killed
+ throw new Error(
+ 'Persistent bash process is not available or was killed.',
+ );
+ }
+ // **** Core execution logic call ****
+ const result = await this.executeCommandInShell(params);
+ resolve(result); // Resolve the specific command's promise
+ } catch (error: any) {
+ console.error(`Error executing command "${params.command}":`, error);
+ reject(error); // Use the specific command's reject handler
+ } finally {
+ this.isExecuting = false;
+ // Use setImmediate to avoid potential deep recursion
+ setImmediate(() => this.triggerQueueProcessing());
}
+ }
+ // --- **** MODIFIED: Core Command Execution Logic **** ---
+ private executeCommandInShell(
+ params: TerminalToolParams,
+ ): Promise<TerminalToolResult> {
+ // Define temp file paths here to be accessible throughout
+ let tempStdoutPath: string | null = null;
+ let tempStderrPath: string | null = null;
+ let originalResolve: (
+ value: TerminalToolResult | PromiseLike<TerminalToolResult>,
+ ) => void; // To pass to polling
+ let originalReject: (reason?: any) => void;
- // --- **** MODIFIED: Core Command Execution Logic **** ---
- private executeCommandInShell(params: TerminalToolParams): Promise<TerminalToolResult> {
- // Define temp file paths here to be accessible throughout
- let tempStdoutPath: string | null = null;
- let tempStderrPath: string | null = null;
- let originalResolve: (value: TerminalToolResult | PromiseLike<TerminalToolResult>) => void; // To pass to polling
- let originalReject: (reason?: any) => void;
-
- const promise = new Promise<TerminalToolResult>((resolve, reject) => {
- originalResolve = resolve; // Assign outer scope resolve
- originalReject = reject; // Assign outer scope reject
+ const promise = new Promise<TerminalToolResult>((resolve, reject) => {
+ originalResolve = resolve; // Assign outer scope resolve
+ originalReject = reject; // Assign outer scope reject
- if (!this.bashProcess) {
- return reject(new Error("Bash process is not running. Cannot execute command."));
- }
+ if (!this.bashProcess) {
+ return reject(
+ new Error('Bash process is not running. Cannot execute command.'),
+ );
+ }
- const isBackgroundTask = params.runInBackground ?? false;
- const commandUUID = crypto.randomUUID();
- const startDelimiter = `::START_CMD_${commandUUID}::`;
- const endDelimiter = `::END_CMD_${commandUUID}::`;
- const exitCodeDelimiter = `::EXIT_CODE_${commandUUID}::`;
- const pidDelimiter = `::PID_${commandUUID}::`; // For background PID
+ const isBackgroundTask = params.runInBackground ?? false;
+ const commandUUID = crypto.randomUUID();
+ const startDelimiter = `::START_CMD_${commandUUID}::`;
+ const endDelimiter = `::END_CMD_${commandUUID}::`;
+ const exitCodeDelimiter = `::EXIT_CODE_${commandUUID}::`;
+ const pidDelimiter = `::PID_${commandUUID}::`; // For background PID
- // --- Initialize Temp Files for Background Task ---
- if (isBackgroundTask) {
- try {
- const tempDir = os.tmpdir();
- tempStdoutPath = path.join(tempDir, `term_out_${commandUUID}.log`);
- tempStderrPath = path.join(tempDir, `term_err_${commandUUID}.log`);
- } catch (err: any) {
- // If temp dir setup fails, reject immediately
- return reject(new Error(`Failed to determine temporary directory: ${err.message}`));
- }
- }
- // --- End Temp File Init ---
+ // --- Initialize Temp Files for Background Task ---
+ if (isBackgroundTask) {
+ try {
+ const tempDir = os.tmpdir();
+ tempStdoutPath = path.join(tempDir, `term_out_${commandUUID}.log`);
+ tempStderrPath = path.join(tempDir, `term_err_${commandUUID}.log`);
+ } catch (err: any) {
+ // If temp dir setup fails, reject immediately
+ return reject(
+ new Error(
+ `Failed to determine temporary directory: ${err.message}`,
+ ),
+ );
+ }
+ }
+ // --- End Temp File Init ---
- let stdoutBuffer = ''; // For launch output
- let stderrBuffer = ''; // For launch output
- let commandOutputStarted = false;
- let exitCode: number | null = null;
- let backgroundPid: number | null = null; // Store PID
- let receivedEndDelimiter = false;
+ let stdoutBuffer = ''; // For launch output
+ let stderrBuffer = ''; // For launch output
+ let commandOutputStarted = false;
+ let exitCode: number | null = null;
+ let backgroundPid: number | null = null; // Store PID
+ let receivedEndDelimiter = false;
- // Timeout only applies to foreground execution or background *launch* phase
- const effectiveTimeout = isBackgroundTask
- ? BACKGROUND_LAUNCH_TIMEOUT_MS
- : Math.min(
- params.timeout ?? DEFAULT_TIMEOUT_MS, // Use default timeout if not provided
- MAX_TIMEOUT_OVERRIDE_MS
- );
+ // Timeout only applies to foreground execution or background *launch* phase
+ const effectiveTimeout = isBackgroundTask
+ ? BACKGROUND_LAUNCH_TIMEOUT_MS
+ : Math.min(
+ params.timeout ?? DEFAULT_TIMEOUT_MS, // Use default timeout if not provided
+ MAX_TIMEOUT_OVERRIDE_MS,
+ );
- let onStdoutData: ((data: Buffer) => void) | null = null;
- let onStderrData: ((data: Buffer) => void) | null = null;
- let launchTimeoutId: NodeJS.Timeout | null = null; // Renamed for clarity
+ let onStdoutData: ((data: Buffer) => void) | null = null;
+ let onStderrData: ((data: Buffer) => void) | null = null;
+ let launchTimeoutId: NodeJS.Timeout | null = null; // Renamed for clarity
- launchTimeoutId = setTimeout(() => {
- const timeoutMessage = isBackgroundTask
- ? `Background command launch timed out after ${effectiveTimeout}ms.`
- : `Command timed out after ${effectiveTimeout}ms.`;
+ launchTimeoutId = setTimeout(() => {
+ const timeoutMessage = isBackgroundTask
+ ? `Background command launch timed out after ${effectiveTimeout}ms.`
+ : `Command timed out after ${effectiveTimeout}ms.`;
- if (!isBackgroundTask && this.bashProcess && !this.bashProcess.killed) {
- try {
- this.bashProcess.stdin.write('\x03'); // Ctrl+C for foreground timeout
- } catch (e: any) { console.error("Error writing SIGINT on timeout:", e); }
- }
- // Store listeners before calling cleanup, as cleanup nullifies them
- const listenersToClean = { onStdoutData, onStderrData };
- cleanupListeners(listenersToClean); // Clean up listeners for this command
+ if (!isBackgroundTask && this.bashProcess && !this.bashProcess.killed) {
+ try {
+ this.bashProcess.stdin.write('\x03'); // Ctrl+C for foreground timeout
+ } catch (e: any) {
+ console.error('Error writing SIGINT on timeout:', e);
+ }
+ }
+ // Store listeners before calling cleanup, as cleanup nullifies them
+ const listenersToClean = { onStdoutData, onStderrData };
+ cleanupListeners(listenersToClean); // Clean up listeners for this command
- // Clean up temp files if background launch timed out
- if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
- this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch(err => {
- console.warn(`Error cleaning up temp files on timeout: ${err.message}`);
- });
- }
+ // Clean up temp files if background launch timed out
+ if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
+ this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch((err) => {
+ console.warn(
+ `Error cleaning up temp files on timeout: ${err.message}`,
+ );
+ });
+ }
- // Resolve the main promise with timeout info
- originalResolve({
- llmContent: `Command execution failed: ${timeoutMessage}\nCommand: ${params.command}\nExecuted in: ${this.currentCwd}\n${isBackgroundTask ? 'Mode: Background Launch' : `Mode: Foreground\nTimeout Limit: ${effectiveTimeout}ms`}\nPartial Stdout (Launch):\n${this.truncateOutput(stdoutBuffer)}\nPartial Stderr (Launch):\n${this.truncateOutput(stderrBuffer)}\nNote: ${isBackgroundTask ? 'Launch failed or took too long.' : 'Attempted interrupt (SIGINT). Shell state might be unpredictable if command ignored interrupt.'}`,
- returnDisplay: `Timeout: ${timeoutMessage}`
- });
- }, effectiveTimeout);
+ // Resolve the main promise with timeout info
+ originalResolve({
+ llmContent: `Command execution failed: ${timeoutMessage}\nCommand: ${params.command}\nExecuted in: ${this.currentCwd}\n${isBackgroundTask ? 'Mode: Background Launch' : `Mode: Foreground\nTimeout Limit: ${effectiveTimeout}ms`}\nPartial Stdout (Launch):\n${this.truncateOutput(stdoutBuffer)}\nPartial Stderr (Launch):\n${this.truncateOutput(stderrBuffer)}\nNote: ${isBackgroundTask ? 'Launch failed or took too long.' : 'Attempted interrupt (SIGINT). Shell state might be unpredictable if command ignored interrupt.'}`,
+ returnDisplay: `Timeout: ${timeoutMessage}`,
+ });
+ }, effectiveTimeout);
- // --- Data processing logic (refined slightly) ---
- const processDataChunk = (chunk: string, isStderr: boolean): boolean => {
- let dataToProcess = chunk;
+ // --- Data processing logic (refined slightly) ---
+ const processDataChunk = (chunk: string, isStderr: boolean): boolean => {
+ let dataToProcess = chunk;
- if (!commandOutputStarted) {
- const startIndex = dataToProcess.indexOf(startDelimiter);
- if (startIndex !== -1) {
- commandOutputStarted = true;
- dataToProcess = dataToProcess.substring(startIndex + startDelimiter.length);
- } else {
- return false; // Still waiting for start delimiter
- }
- }
+ if (!commandOutputStarted) {
+ const startIndex = dataToProcess.indexOf(startDelimiter);
+ if (startIndex !== -1) {
+ commandOutputStarted = true;
+ dataToProcess = dataToProcess.substring(
+ startIndex + startDelimiter.length,
+ );
+ } else {
+ return false; // Still waiting for start delimiter
+ }
+ }
- // Process PID delimiter (mostly expected on stderr for background)
- const pidIndex = dataToProcess.indexOf(pidDelimiter);
- if (pidIndex !== -1) {
- // Extract PID value strictly between delimiter and newline/end
- const pidMatch = dataToProcess.substring(pidIndex + pidDelimiter.length).match(/^(\d+)/);
- if (pidMatch?.[1]) {
- backgroundPid = parseInt(pidMatch[1], 10);
- const pidEndIndex = pidIndex + pidDelimiter.length + pidMatch[1].length;
- const beforePid = dataToProcess.substring(0, pidIndex);
- if (isStderr) stderrBuffer += beforePid; else stdoutBuffer += beforePid;
- dataToProcess = dataToProcess.substring(pidEndIndex);
- } else {
- // Consume delimiter even if no number followed
- const beforePid = dataToProcess.substring(0, pidIndex);
- if (isStderr) stderrBuffer += beforePid; else stdoutBuffer += beforePid;
- dataToProcess = dataToProcess.substring(pidIndex + pidDelimiter.length);
- }
- }
+ // Process PID delimiter (mostly expected on stderr for background)
+ const pidIndex = dataToProcess.indexOf(pidDelimiter);
+ if (pidIndex !== -1) {
+ // Extract PID value strictly between delimiter and newline/end
+ const pidMatch = dataToProcess
+ .substring(pidIndex + pidDelimiter.length)
+ .match(/^(\d+)/);
+ if (pidMatch?.[1]) {
+ backgroundPid = parseInt(pidMatch[1], 10);
+ const pidEndIndex =
+ pidIndex + pidDelimiter.length + pidMatch[1].length;
+ const beforePid = dataToProcess.substring(0, pidIndex);
+ if (isStderr) stderrBuffer += beforePid;
+ else stdoutBuffer += beforePid;
+ dataToProcess = dataToProcess.substring(pidEndIndex);
+ } else {
+ // Consume delimiter even if no number followed
+ const beforePid = dataToProcess.substring(0, pidIndex);
+ if (isStderr) stderrBuffer += beforePid;
+ else stdoutBuffer += beforePid;
+ dataToProcess = dataToProcess.substring(
+ pidIndex + pidDelimiter.length,
+ );
+ }
+ }
+ // Process Exit Code delimiter
+ const exitCodeIndex = dataToProcess.indexOf(exitCodeDelimiter);
+ if (exitCodeIndex !== -1) {
+ const exitCodeMatch = dataToProcess
+ .substring(exitCodeIndex + exitCodeDelimiter.length)
+ .match(/^(\d+)/);
+ if (exitCodeMatch?.[1]) {
+ exitCode = parseInt(exitCodeMatch[1], 10);
+ const beforeExitCode = dataToProcess.substring(0, exitCodeIndex);
+ if (isStderr) stderrBuffer += beforeExitCode;
+ else stdoutBuffer += beforeExitCode;
+ dataToProcess = dataToProcess.substring(
+ exitCodeIndex +
+ exitCodeDelimiter.length +
+ exitCodeMatch[1].length,
+ );
+ } else {
+ const beforeExitCode = dataToProcess.substring(0, exitCodeIndex);
+ if (isStderr) stderrBuffer += beforeExitCode;
+ else stdoutBuffer += beforeExitCode;
+ dataToProcess = dataToProcess.substring(
+ exitCodeIndex + exitCodeDelimiter.length,
+ );
+ }
+ }
- // Process Exit Code delimiter
- const exitCodeIndex = dataToProcess.indexOf(exitCodeDelimiter);
- if (exitCodeIndex !== -1) {
- const exitCodeMatch = dataToProcess.substring(exitCodeIndex + exitCodeDelimiter.length).match(/^(\d+)/);
- if (exitCodeMatch?.[1]) {
- exitCode = parseInt(exitCodeMatch[1], 10);
- const beforeExitCode = dataToProcess.substring(0, exitCodeIndex);
- if (isStderr) stderrBuffer += beforeExitCode; else stdoutBuffer += beforeExitCode;
- dataToProcess = dataToProcess.substring(exitCodeIndex + exitCodeDelimiter.length + exitCodeMatch[1].length);
- } else {
- const beforeExitCode = dataToProcess.substring(0, exitCodeIndex);
- if (isStderr) stderrBuffer += beforeExitCode; else stdoutBuffer += beforeExitCode;
- dataToProcess = dataToProcess.substring(exitCodeIndex + exitCodeDelimiter.length);
- }
- }
+ // Process End delimiter
+ const endDelimiterIndex = dataToProcess.indexOf(endDelimiter);
+ if (endDelimiterIndex !== -1) {
+ receivedEndDelimiter = true;
+ const beforeEndDelimiter = dataToProcess.substring(
+ 0,
+ endDelimiterIndex,
+ );
+ if (isStderr) stderrBuffer += beforeEndDelimiter;
+ else stdoutBuffer += beforeEndDelimiter;
+ // Consume delimiter and potentially the exit code echoed after it
+ const afterEndDelimiter = dataToProcess.substring(
+ endDelimiterIndex + endDelimiter.length,
+ );
+ const exitCodeEchoMatch = afterEndDelimiter.match(/^(\d+)/);
+ dataToProcess = exitCodeEchoMatch
+ ? afterEndDelimiter.substring(exitCodeEchoMatch[1].length)
+ : afterEndDelimiter;
+ }
- // Process End delimiter
- const endDelimiterIndex = dataToProcess.indexOf(endDelimiter);
- if (endDelimiterIndex !== -1) {
- receivedEndDelimiter = true;
- const beforeEndDelimiter = dataToProcess.substring(0, endDelimiterIndex);
- if (isStderr) stderrBuffer += beforeEndDelimiter; else stdoutBuffer += beforeEndDelimiter;
- // Consume delimiter and potentially the exit code echoed after it
- const afterEndDelimiter = dataToProcess.substring(endDelimiterIndex + endDelimiter.length);
- const exitCodeEchoMatch = afterEndDelimiter.match(/^(\d+)/);
- dataToProcess = exitCodeEchoMatch ? afterEndDelimiter.substring(exitCodeEchoMatch[1].length) : afterEndDelimiter;
- }
+ // Append remaining data
+ if (dataToProcess.length > 0) {
+ if (isStderr) stderrBuffer += dataToProcess;
+ else stdoutBuffer += dataToProcess;
+ }
- // Append remaining data
- if (dataToProcess.length > 0) {
- if (isStderr) stderrBuffer += dataToProcess; else stdoutBuffer += dataToProcess;
- }
+ // Check completion criteria
+ if (receivedEndDelimiter && exitCode !== null) {
+ setImmediate(cleanupAndResolve); // Use setImmediate
+ return true; // Signal completion of this command's stream processing
+ }
- // Check completion criteria
- if (receivedEndDelimiter && exitCode !== null) {
- setImmediate(cleanupAndResolve); // Use setImmediate
- return true; // Signal completion of this command's stream processing
- }
+ return false; // More data or delimiters expected
+ };
- return false; // More data or delimiters expected
- };
+ // Assign listeners
+ onStdoutData = (data: Buffer) => processDataChunk(data.toString(), false);
+ onStderrData = (data: Buffer) => processDataChunk(data.toString(), true);
- // Assign listeners
- onStdoutData = (data: Buffer) => processDataChunk(data.toString(), false);
- onStderrData = (data: Buffer) => processDataChunk(data.toString(), true);
+ // --- Cleanup Logic ---
+ // Pass listeners to allow cleanup even if they are nullified later
+ const cleanupListeners = (listeners?: {
+ onStdoutData: any;
+ onStderrData: any;
+ }) => {
+ if (launchTimeoutId) clearTimeout(launchTimeoutId);
+ launchTimeoutId = null;
- // --- Cleanup Logic ---
- // Pass listeners to allow cleanup even if they are nullified later
- const cleanupListeners = (listeners?: { onStdoutData: any, onStderrData: any }) => {
- if (launchTimeoutId) clearTimeout(launchTimeoutId);
- launchTimeoutId = null;
+ // Use passed-in listeners if available, otherwise use current scope's
+ const stdoutListener = listeners?.onStdoutData ?? onStdoutData;
+ const stderrListener = listeners?.onStderrData ?? onStderrData;
- // Use passed-in listeners if available, otherwise use current scope's
- const stdoutListener = listeners?.onStdoutData ?? onStdoutData;
- const stderrListener = listeners?.onStderrData ?? onStderrData;
+ if (this.bashProcess && !this.bashProcess.killed) {
+ if (stdoutListener)
+ this.bashProcess.stdout.removeListener('data', stdoutListener);
+ if (stderrListener)
+ this.bashProcess.stderr.removeListener('data', stderrListener);
+ }
+ // Only nullify the *current command's* cleanup reference if it matches
+ if (this.currentCommandCleanup === cleanupListeners) {
+ this.currentCommandCleanup = null;
+ }
+ // Nullify the listener references in the outer scope regardless
+ onStdoutData = null;
+ onStderrData = null;
+ };
+ // Store *this specific* cleanup function instance for the current command
+ this.currentCommandCleanup = cleanupListeners;
- if (this.bashProcess && !this.bashProcess.killed) {
- if (stdoutListener) this.bashProcess.stdout.removeListener('data', stdoutListener);
- if (stderrListener) this.bashProcess.stderr.removeListener('data', stderrListener);
- }
- // Only nullify the *current command's* cleanup reference if it matches
- if (this.currentCommandCleanup === cleanupListeners) {
- this.currentCommandCleanup = null;
- }
- // Nullify the listener references in the outer scope regardless
- onStdoutData = null;
- onStderrData = null;
- };
- // Store *this specific* cleanup function instance for the current command
- this.currentCommandCleanup = cleanupListeners;
+ // --- Final Resolution / Polling Logic ---
+ const cleanupAndResolve = async () => {
+ // Prevent double execution if cleanup was already called (e.g., by timeout)
+ if (
+ !this.currentCommandCleanup ||
+ this.currentCommandCleanup !== cleanupListeners
+ ) {
+ // Ensure temp files are cleaned if this command was superseded but might have created them
+ if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
+ this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch(
+ (err) => {
+ console.warn(
+ `Error cleaning up temp files for superseded command: ${err.message}`,
+ );
+ },
+ );
+ }
+ return;
+ }
- // --- Final Resolution / Polling Logic ---
- const cleanupAndResolve = async () => {
- // Prevent double execution if cleanup was already called (e.g., by timeout)
- if (!this.currentCommandCleanup || this.currentCommandCleanup !== cleanupListeners) {
- // Ensure temp files are cleaned if this command was superseded but might have created them
- if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
- this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch(err => {
- console.warn(`Error cleaning up temp files for superseded command: ${err.message}`);
- });
- }
- return;
- }
+ // Capture initial output *before* cleanup nullifies buffers indirectly
+ const launchStdout = this.truncateOutput(stdoutBuffer);
+ const launchStderr = this.truncateOutput(stderrBuffer);
- // Capture initial output *before* cleanup nullifies buffers indirectly
- const launchStdout = this.truncateOutput(stdoutBuffer);
- const launchStderr = this.truncateOutput(stderrBuffer);
+ // Store listeners before calling cleanup
+ const listenersToClean = { onStdoutData, onStderrData };
+ cleanupListeners(listenersToClean); // Remove listeners and clear launch timeout NOW
- // Store listeners before calling cleanup
- const listenersToClean = { onStdoutData, onStderrData };
- cleanupListeners(listenersToClean); // Remove listeners and clear launch timeout NOW
+ // --- Error check for missing exit code ---
+ if (exitCode === null) {
+ console.error(
+ `CRITICAL: Command "${params.command}" (background: ${isBackgroundTask}) finished delimiter processing but exitCode is null.`,
+ );
+ const errorMode = isBackgroundTask
+ ? 'Background Launch'
+ : 'Foreground';
+ if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
+ await this.cleanupTempFiles(tempStdoutPath, tempStderrPath);
+ }
+ originalResolve({
+ // Use originalResolve as this is a failure *before* polling starts
+ llmContent: `Command: ${params.command}\nExecuted in: ${this.currentCwd}\nMode: ${errorMode}\nExit Code: -2 (Internal Error: Exit code not captured)\nStdout (during setup):\n${launchStdout}\nStderr (during setup):\n${launchStderr}`,
+ returnDisplay:
+ `Internal Error: Failed to capture command exit code.\n${launchStdout}\nStderr: ${launchStderr}`.trim(),
+ });
+ return;
+ }
- // --- Error check for missing exit code ---
- if (exitCode === null) {
- console.error(`CRITICAL: Command "${params.command}" (background: ${isBackgroundTask}) finished delimiter processing but exitCode is null.`);
- const errorMode = isBackgroundTask ? 'Background Launch' : 'Foreground';
- if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
- await this.cleanupTempFiles(tempStdoutPath, tempStderrPath);
- }
- originalResolve({ // Use originalResolve as this is a failure *before* polling starts
- llmContent: `Command: ${params.command}\nExecuted in: ${this.currentCwd}\nMode: ${errorMode}\nExit Code: -2 (Internal Error: Exit code not captured)\nStdout (during setup):\n${launchStdout}\nStderr (during setup):\n${launchStderr}`,
- returnDisplay: `Internal Error: Failed to capture command exit code.\n${launchStdout}\nStderr: ${launchStderr}`.trim()
- });
- return;
- }
+ // --- CWD Update Logic (Only for Foreground Success or 'cd') ---
+ let cwdUpdateError = '';
+ if (!isBackgroundTask) {
+ // Only run for foreground
+ const mightChangeCwd = params.command.trim().startsWith('cd ');
+ if (exitCode === 0 || mightChangeCwd) {
+ try {
+ const latestCwd = await this.getCurrentShellCwd();
+ if (this.currentCwd !== latestCwd) {
+ this.currentCwd = latestCwd;
+ }
+ } catch (e: any) {
+ if (exitCode === 0) {
+ // Only warn if the command itself succeeded
+ cwdUpdateError = `\nWarning: Failed to verify/update current working directory after command: ${e.message}`;
+ console.error(
+ 'Failed to update CWD after successful command:',
+ e,
+ );
+ }
+ }
+ }
+ }
+ // --- End CWD Update ---
- // --- CWD Update Logic (Only for Foreground Success or 'cd') ---
- let cwdUpdateError = '';
- if (!isBackgroundTask) { // Only run for foreground
- const mightChangeCwd = params.command.trim().startsWith('cd ');
- if (exitCode === 0 || mightChangeCwd) {
- try {
- const latestCwd = await this.getCurrentShellCwd();
- if (this.currentCwd !== latestCwd) {
- this.currentCwd = latestCwd;
- }
- } catch (e: any) {
- if (exitCode === 0) { // Only warn if the command itself succeeded
- cwdUpdateError = `\nWarning: Failed to verify/update current working directory after command: ${e.message}`;
- console.error("Failed to update CWD after successful command:", e);
- }
- }
- }
- }
- // --- End CWD Update ---
+ // --- Result Formatting & Polling Decision ---
+ if (isBackgroundTask) {
+ const launchSuccess = exitCode === 0;
+ const pidString =
+ backgroundPid !== null ? backgroundPid.toString() : 'Not Captured';
- // --- Result Formatting & Polling Decision ---
- if (isBackgroundTask) {
- const launchSuccess = exitCode === 0;
- const pidString = backgroundPid !== null ? backgroundPid.toString() : 'Not Captured';
+ // Check if polling should start
+ if (
+ launchSuccess &&
+ backgroundPid !== null &&
+ tempStdoutPath &&
+ tempStderrPath
+ ) {
+ // --- START POLLING ---
+ // Don't await this, let it run in the background and resolve the original promise later
+ this.inspectBackgroundProcess(
+ backgroundPid,
+ params.command,
+ this.currentCwd, // CWD at time of launch
+ launchStdout, // Initial output captured during launch
+ launchStderr, // Initial output captured during launch
+ tempStdoutPath, // Path for final stdout
+ tempStderrPath, // Path for final stderr
+ originalResolve, // The resolve function of the main promise
+ );
+ // IMPORTANT: Do NOT resolve the promise here. pollBackgroundProcess will do it.
+ // --- END POLLING ---
+ } else {
+ // Background launch failed OR PID was not captured OR temp files missing
+ const reason =
+ backgroundPid === null
+ ? 'PID not captured'
+ : `Launch failed (Exit Code: ${exitCode})`;
+ const displayMessage = `Failed to launch process in background (${reason})`;
+ console.error(
+ `Background launch failed for command: ${params.command}. Reason: ${reason}`,
+ ); // ERROR LOG
+ // Ensure cleanup of temp files if launch failed
+ if (tempStdoutPath && tempStderrPath) {
+ await this.cleanupTempFiles(tempStdoutPath, tempStderrPath);
+ }
+ originalResolve({
+ // Use originalResolve as polling won't start
+ llmContent: `Background Command Launch Failed: ${params.command}\nExecuted in: ${this.currentCwd}\nReason: ${reason}\nPID: ${pidString}\nExit Code (Launch): ${exitCode}\nStdout (During Launch):\n${launchStdout}\nStderr (During Launch):\n${launchStderr}`,
+ returnDisplay: displayMessage,
+ });
+ }
+ } else {
+ // --- Foreground task result (resolve immediately) ---
+ let displayOutput = '';
+ const stdoutTrimmed = launchStdout.trim();
+ const stderrTrimmed = launchStderr.trim();
- // Check if polling should start
- if (launchSuccess && backgroundPid !== null && tempStdoutPath && tempStderrPath) {
- // --- START POLLING ---
- // Don't await this, let it run in the background and resolve the original promise later
- this.inspectBackgroundProcess(
- backgroundPid,
- params.command,
- this.currentCwd, // CWD at time of launch
- launchStdout, // Initial output captured during launch
- launchStderr, // Initial output captured during launch
- tempStdoutPath, // Path for final stdout
- tempStderrPath, // Path for final stderr
- originalResolve // The resolve function of the main promise
- );
- // IMPORTANT: Do NOT resolve the promise here. pollBackgroundProcess will do it.
- // --- END POLLING ---
- } else {
- // Background launch failed OR PID was not captured OR temp files missing
- const reason = backgroundPid === null ? "PID not captured" : `Launch failed (Exit Code: ${exitCode})`;
- const displayMessage = `Failed to launch process in background (${reason})`;
- console.error(`Background launch failed for command: ${params.command}. Reason: ${reason}`); // ERROR LOG
- // Ensure cleanup of temp files if launch failed
- if (tempStdoutPath && tempStderrPath) {
- await this.cleanupTempFiles(tempStdoutPath, tempStderrPath);
- }
- originalResolve({ // Use originalResolve as polling won't start
- llmContent: `Background Command Launch Failed: ${params.command}\nExecuted in: ${this.currentCwd}\nReason: ${reason}\nPID: ${pidString}\nExit Code (Launch): ${exitCode}\nStdout (During Launch):\n${launchStdout}\nStderr (During Launch):\n${launchStderr}`,
- returnDisplay: displayMessage
- });
- }
+ if (stderrTrimmed) {
+ displayOutput = stderrTrimmed;
+ } else if (stdoutTrimmed) {
+ displayOutput = stdoutTrimmed;
+ }
- } else {
- // --- Foreground task result (resolve immediately) ---
- let displayOutput = '';
- const stdoutTrimmed = launchStdout.trim();
- const stderrTrimmed = launchStderr.trim();
+ if (exitCode !== 0 && !displayOutput) {
+ displayOutput = `Failed with exit code: ${exitCode}`;
+ } else if (exitCode === 0 && !displayOutput) {
+ displayOutput = `Success (no output)`;
+ }
- if (stderrTrimmed) {
- displayOutput = stderrTrimmed;
- } else if (stdoutTrimmed) {
- displayOutput = stdoutTrimmed;
- }
+ originalResolve({
+ // Use originalResolve for foreground result
+ llmContent: `Command: ${params.command}\nExecuted in: ${this.currentCwd}\nExit Code: ${exitCode}\nStdout:\n${launchStdout}\nStderr:\n${launchStderr}${cwdUpdateError}`,
+ returnDisplay: displayOutput.trim() || `Exit Code: ${exitCode}`, // Ensure some display
+ });
+ // --- End Foreground Result ---
+ }
+ }; // End of cleanupAndResolve
- if (exitCode !== 0 && !displayOutput) {
- displayOutput = `Failed with exit code: ${exitCode}`;
- } else if (exitCode === 0 && !displayOutput) {
- displayOutput = `Success (no output)`;
- }
+ // --- Attach listeners ---
+ if (!this.bashProcess || this.bashProcess.killed) {
+ console.error(
+ 'Bash process lost or killed before listeners could be attached.',
+ );
+ // Ensure temp files are cleaned up if they exist
+ if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
+ this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch((err) => {
+ console.warn(
+ `Error cleaning up temp files on attach failure: ${err.message}`,
+ );
+ });
+ }
+ return originalReject(
+ new Error(
+ 'Bash process lost or killed before listeners could be attached.',
+ ),
+ );
+ }
+ // Defensive remove shouldn't be strictly necessary with current cleanup logic, but harmless
+ // if (onStdoutData) this.bashProcess.stdout.removeListener('data', onStdoutData);
+ // if (onStderrData) this.bashProcess.stderr.removeListener('data', onStderrData);
- originalResolve({ // Use originalResolve for foreground result
- llmContent: `Command: ${params.command}\nExecuted in: ${this.currentCwd}\nExit Code: ${exitCode}\nStdout:\n${launchStdout}\nStderr:\n${launchStderr}${cwdUpdateError}`,
- returnDisplay: displayOutput.trim() || `Exit Code: ${exitCode}` // Ensure some display
- });
- // --- End Foreground Result ---
- }
- }; // End of cleanupAndResolve
+ // Attach the fresh listeners
+ if (onStdoutData) this.bashProcess.stdout.on('data', onStdoutData);
+ if (onStderrData) this.bashProcess.stderr.on('data', onStderrData);
+ // --- Construct and Write Command ---
+ let commandToWrite: string;
+ if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
+ // Background: Redirect command's stdout/stderr to temp files.
+ // Use subshell { ... } > file 2> file to redirect the command inside.
+ // Capture PID of the subshell. Capture exit code of the subshell launch.
+ // Ensure the subshell itself doesn't interfere with delimiter capture on stderr.
+ commandToWrite = `echo "${startDelimiter}"; { { ${params.command} > "${tempStdoutPath}" 2> "${tempStderrPath}"; } & } 2>/dev/null; __LAST_PID=$!; echo "${pidDelimiter}$__LAST_PID" >&2; echo "${exitCodeDelimiter}$?" >&2; echo "${endDelimiter}$?" >&1\n`;
+ } else if (!isBackgroundTask) {
+ // Foreground: Original structure. Capture command exit code.
+ commandToWrite = `echo "${startDelimiter}"; ${params.command}; __EXIT_CODE=$?; echo "${exitCodeDelimiter}$__EXIT_CODE" >&2; echo "${endDelimiter}$__EXIT_CODE" >&1\n`;
+ } else {
+ // Should not happen if background task setup failed, but handle defensively
+ return originalReject(
+ new Error(
+ 'Internal setup error: Missing temporary file paths for background execution.',
+ ),
+ );
+ }
- // --- Attach listeners ---
- if (!this.bashProcess || this.bashProcess.killed) {
- console.error("Bash process lost or killed before listeners could be attached.");
- // Ensure temp files are cleaned up if they exist
- if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
- this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch(err => {
- console.warn(`Error cleaning up temp files on attach failure: ${err.message}`);
- });
- }
- return originalReject(new Error("Bash process lost or killed before listeners could be attached."));
+ try {
+ if (this.bashProcess?.stdin?.writable) {
+ this.bashProcess.stdin.write(commandToWrite, (err) => {
+ if (err) {
+ console.error(
+ `Error writing command "${params.command}" to bash stdin (callback):`,
+ err,
+ );
+ // Store listeners before calling cleanup
+ const listenersToClean = {
+ onStdoutData,
+ onStderrData,
+ };
+ cleanupListeners(listenersToClean); // Attempt cleanup
+ if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
+ this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch(
+ (e) => console.warn(`Cleanup failed: ${e.message}`),
+ );
+ }
+ originalReject(
+ new Error(
+ `Shell stdin write error: ${err.message}. Command likely did not execute.`,
+ ),
+ );
}
- // Defensive remove shouldn't be strictly necessary with current cleanup logic, but harmless
- // if (onStdoutData) this.bashProcess.stdout.removeListener('data', onStdoutData);
- // if (onStderrData) this.bashProcess.stderr.removeListener('data', onStderrData);
-
- // Attach the fresh listeners
- if (onStdoutData) this.bashProcess.stdout.on('data', onStdoutData);
- if (onStderrData) this.bashProcess.stderr.on('data', onStderrData);
+ });
+ } else {
+ throw new Error(
+ 'Shell stdin is not writable or process closed when attempting to write command.',
+ );
+ }
+ } catch (e: any) {
+ console.error(
+ `Error writing command "${params.command}" to bash stdin (sync):`,
+ e,
+ );
+ // Store listeners before calling cleanup
+ const listenersToClean = { onStdoutData, onStderrData };
+ cleanupListeners(listenersToClean); // Attempt cleanup
+ if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
+ this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch((err) =>
+ console.warn(`Cleanup failed: ${err.message}`),
+ );
+ }
+ originalReject(
+ new Error(
+ `Shell stdin write exception: ${e.message}. Command likely did not execute.`,
+ ),
+ );
+ }
+ }); // End of main promise constructor
- // --- Construct and Write Command ---
- let commandToWrite: string;
- if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
- // Background: Redirect command's stdout/stderr to temp files.
- // Use subshell { ... } > file 2> file to redirect the command inside.
- // Capture PID of the subshell. Capture exit code of the subshell launch.
- // Ensure the subshell itself doesn't interfere with delimiter capture on stderr.
- commandToWrite = `echo "${startDelimiter}"; { { ${params.command} > "${tempStdoutPath}" 2> "${tempStderrPath}"; } & } 2>/dev/null; __LAST_PID=$!; echo "${pidDelimiter}$__LAST_PID" >&2; echo "${exitCodeDelimiter}$?" >&2; echo "${endDelimiter}$?" >&1\n`;
- } else if (!isBackgroundTask) {
- // Foreground: Original structure. Capture command exit code.
- commandToWrite = `echo "${startDelimiter}"; ${params.command}; __EXIT_CODE=$?; echo "${exitCodeDelimiter}$__EXIT_CODE" >&2; echo "${endDelimiter}$__EXIT_CODE" >&1\n`;
- } else {
- // Should not happen if background task setup failed, but handle defensively
- return originalReject(new Error("Internal setup error: Missing temporary file paths for background execution."));
- }
+ return promise; // Return the promise created at the top
+ } // End of executeCommandInShell
- try {
- if (this.bashProcess?.stdin?.writable) {
- this.bashProcess.stdin.write(commandToWrite, (err) => {
- if (err) {
- console.error(`Error writing command "${params.command}" to bash stdin (callback):`, err);
- // Store listeners before calling cleanup
- const listenersToClean = { onStdoutData, onStderrData };
- cleanupListeners(listenersToClean); // Attempt cleanup
- if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
- this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch(e => console.warn(`Cleanup failed: ${e.message}`));
- }
- originalReject(new Error(`Shell stdin write error: ${err.message}. Command likely did not execute.`));
- }
- });
- } else {
- throw new Error("Shell stdin is not writable or process closed when attempting to write command.");
- }
- } catch (e: any) {
- console.error(`Error writing command "${params.command}" to bash stdin (sync):`, e);
- // Store listeners before calling cleanup
- const listenersToClean = { onStdoutData, onStderrData };
- cleanupListeners(listenersToClean); // Attempt cleanup
- if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
- this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch(err => console.warn(`Cleanup failed: ${err.message}`));
- }
- originalReject(new Error(`Shell stdin write exception: ${e.message}. Command likely did not execute.`));
- }
- }); // End of main promise constructor
+ // --- **** NEW: Background Process Polling **** ---
+ private async inspectBackgroundProcess(
+ pid: number,
+ command: string,
+ cwd: string,
+ initialStdout: string, // Stdout during launch phase
+ initialStderr: string, // Stderr during launch phase
+ tempStdoutPath: string, // Path to redirected stdout
+ tempStderrPath: string, // Path to redirected stderr
+ resolve: (
+ value: TerminalToolResult | PromiseLike<TerminalToolResult>,
+ ) => void, // The original promise's resolve
+ ): Promise<void> {
+ // This function manages its own lifecycle but resolves the outer promise
+ let finalStdout = '';
+ let finalStderr = '';
+ let llmAnalysis = '';
+ let fileReadError = '';
- return promise; // Return the promise created at the top
- } // End of executeCommandInShell
+ // --- Call LLM Analysis ---
+ try {
+ const { status, summary } = await this.backgroundTerminalAnalyzer.analyze(
+ pid,
+ tempStdoutPath,
+ tempStderrPath,
+ command,
+ );
+ if (status === 'Unknown') llmAnalysis = `LLM analysis failed: ${summary}`;
+ else llmAnalysis = summary;
+ } catch (llmError: any) {
+ console.error(
+ `LLM analysis failed for PID ${pid} command "${command}":`,
+ llmError,
+ );
+ llmAnalysis = `LLM analysis failed: ${llmError.message}`; // Include error in analysis placeholder
+ }
+ // --- End LLM Call ---
+ try {
+ finalStdout = await fs.readFile(tempStdoutPath, 'utf-8');
+ finalStderr = await fs.readFile(tempStderrPath, 'utf-8');
+ } catch (err: any) {
+ console.error(`Error reading temp output files for PID ${pid}:`, err);
+ fileReadError = `\nWarning: Failed to read temporary output files (${err.message}). Final output may be incomplete.`;
+ }
- // --- **** NEW: Background Process Polling **** ---
- private async inspectBackgroundProcess(
- pid: number,
- command: string,
- cwd: string,
- initialStdout: string, // Stdout during launch phase
- initialStderr: string, // Stderr during launch phase
- tempStdoutPath: string, // Path to redirected stdout
- tempStderrPath: string, // Path to redirected stderr
- resolve: (value: TerminalToolResult | PromiseLike<TerminalToolResult>) => void // The original promise's resolve
- ): Promise<void> { // This function manages its own lifecycle but resolves the outer promise
- let finalStdout = '';
- let finalStderr = '';
- let llmAnalysis = '';
- let fileReadError = '';
+ // --- Clean up temp files ---
+ await this.cleanupTempFiles(tempStdoutPath, tempStderrPath);
+ // --- End Cleanup ---
- // --- Call LLM Analysis ---
- try {
- const { status, summary } = await this.backgroundTerminalAnalyzer.analyze(pid, tempStdoutPath, tempStderrPath, command);
- if (status === 'Unknown')
- llmAnalysis = `LLM analysis failed: ${summary}`;
- else
- llmAnalysis = summary;
+ const truncatedFinalStdout = this.truncateOutput(finalStdout);
+ const truncatedFinalStderr = this.truncateOutput(finalStderr);
- } catch (llmError: any) {
- console.error(`LLM analysis failed for PID ${pid} command "${command}":`, llmError);
- llmAnalysis = `LLM analysis failed: ${llmError.message}`; // Include error in analysis placeholder
- }
- // --- End LLM Call ---
+ // Resolve the original promise passed into pollBackgroundProcess
+ resolve({
+ llmContent: `Background Command: ${command}\nLaunched in: ${cwd}\nPID: ${pid}\n--- LLM Analysis ---\n${llmAnalysis}\n--- Final Stdout (from ${path.basename(tempStdoutPath)}) ---\n${truncatedFinalStdout}\n--- Final Stderr (from ${path.basename(tempStderrPath)}) ---\n${truncatedFinalStderr}\n--- Launch Stdout ---\n${initialStdout}\n--- Launch Stderr ---\n${initialStderr}${fileReadError}`,
+ returnDisplay: `(PID: ${pid}): ${this.truncateOutput(llmAnalysis, 200)}`,
+ });
+ } // End of pollBackgroundProcess
- try {
- finalStdout = await fs.readFile(tempStdoutPath, 'utf-8');
- finalStderr = await fs.readFile(tempStderrPath, 'utf-8');
- } catch (err: any) {
- console.error(`Error reading temp output files for PID ${pid}:`, err);
- fileReadError = `\nWarning: Failed to read temporary output files (${err.message}). Final output may be incomplete.`;
+ // --- **** NEW: Helper to cleanup temp files **** ---
+ private async cleanupTempFiles(
+ stdoutPath: string | null,
+ stderrPath: string | null,
+ ): Promise<void> {
+ const unlinkQuietly = async (filePath: string | null) => {
+ if (!filePath) return;
+ try {
+ await fs.unlink(filePath);
+ } catch (err: any) {
+ // Ignore errors like file not found (it might have been deleted already or failed to create)
+ if (err.code !== 'ENOENT') {
+ console.warn(
+ `Failed to delete temporary file '${filePath}': ${err.message}`,
+ );
+ } else {
}
+ }
+ };
+ // Run deletions concurrently and wait for both
+ await Promise.all([unlinkQuietly(stdoutPath), unlinkQuietly(stderrPath)]);
+ }
- // --- Clean up temp files ---
- await this.cleanupTempFiles(tempStdoutPath, tempStderrPath);
- // --- End Cleanup ---
-
- const truncatedFinalStdout = this.truncateOutput(finalStdout);
- const truncatedFinalStderr = this.truncateOutput(finalStderr);
-
- // Resolve the original promise passed into pollBackgroundProcess
- resolve({
- llmContent: `Background Command: ${command}\nLaunched in: ${cwd}\nPID: ${pid}\n--- LLM Analysis ---\n${llmAnalysis}\n--- Final Stdout (from ${path.basename(tempStdoutPath)}) ---\n${truncatedFinalStdout}\n--- Final Stderr (from ${path.basename(tempStderrPath)}) ---\n${truncatedFinalStderr}\n--- Launch Stdout ---\n${initialStdout}\n--- Launch Stderr ---\n${initialStderr}${fileReadError}`,
- returnDisplay: `(PID: ${pid}): ${this.truncateOutput(llmAnalysis, 200)}`
- });
- } // End of pollBackgroundProcess
-
- // --- **** NEW: Helper to cleanup temp files **** ---
- private async cleanupTempFiles(stdoutPath: string | null, stderrPath: string | null): Promise<void> {
- const unlinkQuietly = async (filePath: string | null) => {
- if (!filePath) return;
- try {
- await fs.unlink(filePath);
- } catch (err: any) {
- // Ignore errors like file not found (it might have been deleted already or failed to create)
- if (err.code !== 'ENOENT') {
- console.warn(`Failed to delete temporary file '${filePath}': ${err.message}`);
- } else {
- }
- }
- };
- // Run deletions concurrently and wait for both
- await Promise.all([
- unlinkQuietly(stdoutPath),
- unlinkQuietly(stderrPath)
- ]);
- }
-
-
- // --- Get CWD (mostly unchanged, added robustness) ---
- private getCurrentShellCwd(): Promise<string> {
- return new Promise((resolve, reject) => {
- if (!this.bashProcess || !this.bashProcess.stdin?.writable || this.bashProcess.killed) {
- return reject(new Error("Shell not running, stdin not writable, or killed for PWD check"));
- }
+ // --- Get CWD (mostly unchanged, added robustness) ---
+ private getCurrentShellCwd(): Promise<string> {
+ return new Promise((resolve, reject) => {
+ if (
+ !this.bashProcess ||
+ !this.bashProcess.stdin?.writable ||
+ this.bashProcess.killed
+ ) {
+ return reject(
+ new Error(
+ 'Shell not running, stdin not writable, or killed for PWD check',
+ ),
+ );
+ }
- const pwdUuid = crypto.randomUUID();
- const pwdDelimiter = `::PWD_${pwdUuid}::`;
- let pwdOutput = '';
- let onPwdData: ((data: Buffer) => void) | null = null;
- let onPwdError: ((data: Buffer) => void) | null = null; // To catch errors during pwd
- let pwdTimeoutId: NodeJS.Timeout | null = null;
- let finished = false; // Prevent double resolution/rejection
+ const pwdUuid = crypto.randomUUID();
+ const pwdDelimiter = `::PWD_${pwdUuid}::`;
+ let pwdOutput = '';
+ let onPwdData: ((data: Buffer) => void) | null = null;
+ let onPwdError: ((data: Buffer) => void) | null = null; // To catch errors during pwd
+ let pwdTimeoutId: NodeJS.Timeout | null = null;
+ let finished = false; // Prevent double resolution/rejection
- const cleanupPwdListeners = (err?: Error) => {
- if (finished) return; // Already handled
- finished = true;
- if (pwdTimeoutId) clearTimeout(pwdTimeoutId);
- pwdTimeoutId = null;
+ const cleanupPwdListeners = (err?: Error) => {
+ if (finished) return; // Already handled
+ finished = true;
+ if (pwdTimeoutId) clearTimeout(pwdTimeoutId);
+ pwdTimeoutId = null;
- const stdoutListener = onPwdData; // Capture current reference
- const stderrListener = onPwdError; // Capture current reference
- onPwdData = null; // Nullify before removing
- onPwdError = null;
+ const stdoutListener = onPwdData; // Capture current reference
+ const stderrListener = onPwdError; // Capture current reference
+ onPwdData = null; // Nullify before removing
+ onPwdError = null;
- if (this.bashProcess && !this.bashProcess.killed) {
- if (stdoutListener) this.bashProcess.stdout.removeListener('data', stdoutListener);
- if (stderrListener) this.bashProcess.stderr.removeListener('data', stderrListener);
- }
+ if (this.bashProcess && !this.bashProcess.killed) {
+ if (stdoutListener)
+ this.bashProcess.stdout.removeListener('data', stdoutListener);
+ if (stderrListener)
+ this.bashProcess.stderr.removeListener('data', stderrListener);
+ }
- if (err) {
- reject(err);
- } else {
- // Trim whitespace and trailing newlines robustly
- resolve(pwdOutput.trim());
- }
- }
+ if (err) {
+ reject(err);
+ } else {
+ // Trim whitespace and trailing newlines robustly
+ resolve(pwdOutput.trim());
+ }
+ };
- onPwdData = (data: Buffer) => {
- if (!onPwdData) return; // Listener removed
- const dataStr = data.toString();
- const delimiterIndex = dataStr.indexOf(pwdDelimiter);
- if (delimiterIndex !== -1) {
- pwdOutput += dataStr.substring(0, delimiterIndex);
- cleanupPwdListeners(); // Resolve successfully
- } else {
- pwdOutput += dataStr;
- }
- };
+ onPwdData = (data: Buffer) => {
+ if (!onPwdData) return; // Listener removed
+ const dataStr = data.toString();
+ const delimiterIndex = dataStr.indexOf(pwdDelimiter);
+ if (delimiterIndex !== -1) {
+ pwdOutput += dataStr.substring(0, delimiterIndex);
+ cleanupPwdListeners(); // Resolve successfully
+ } else {
+ pwdOutput += dataStr;
+ }
+ };
- onPwdError = (data: Buffer) => {
- if (!onPwdError) return; // Listener removed
- const dataStr = data.toString();
- // If delimiter appears on stderr, or any stderr occurs, treat as error
- console.error(`Error during PWD check: ${dataStr}`);
- cleanupPwdListeners(new Error(`Stderr received during pwd check: ${this.truncateOutput(dataStr, 100)}`));
- };
+ onPwdError = (data: Buffer) => {
+ if (!onPwdError) return; // Listener removed
+ const dataStr = data.toString();
+ // If delimiter appears on stderr, or any stderr occurs, treat as error
+ console.error(`Error during PWD check: ${dataStr}`);
+ cleanupPwdListeners(
+ new Error(
+ `Stderr received during pwd check: ${this.truncateOutput(dataStr, 100)}`,
+ ),
+ );
+ };
- // Attach listeners
- this.bashProcess.stdout.on('data', onPwdData);
- this.bashProcess.stderr.on('data', onPwdError);
+ // Attach listeners
+ this.bashProcess.stdout.on('data', onPwdData);
+ this.bashProcess.stderr.on('data', onPwdError);
- // Set timeout
- pwdTimeoutId = setTimeout(() => {
- cleanupPwdListeners(new Error("Timeout waiting for pwd response"));
- }, 5000); // 5 second timeout for pwd
+ // Set timeout
+ pwdTimeoutId = setTimeout(() => {
+ cleanupPwdListeners(new Error('Timeout waiting for pwd response'));
+ }, 5000); // 5 second timeout for pwd
- // Write command
- try {
- // Use printf for robustness against special characters in PWD and ensure newline
- const pwdCommand = `printf "%s" "$PWD"; printf "${pwdDelimiter}";\n`;
- if (this.bashProcess?.stdin?.writable) {
- this.bashProcess.stdin.write(pwdCommand, (err) => {
- if (err) {
- // Error during write callback, likely means shell is unresponsive
- console.error("Error writing pwd command (callback):", err);
- cleanupPwdListeners(new Error(`Failed to write pwd command: ${err.message}`));
- }
- });
- } else {
- throw new Error("Shell stdin not writable for pwd command.");
- }
- } catch (e: any) {
- console.error("Exception writing pwd command:", e);
- cleanupPwdListeners(new Error(`Exception writing pwd command: ${e.message}`));
+ // Write command
+ try {
+ // Use printf for robustness against special characters in PWD and ensure newline
+ const pwdCommand = `printf "%s" "$PWD"; printf "${pwdDelimiter}";\n`;
+ if (this.bashProcess?.stdin?.writable) {
+ this.bashProcess.stdin.write(pwdCommand, (err) => {
+ if (err) {
+ // Error during write callback, likely means shell is unresponsive
+ console.error('Error writing pwd command (callback):', err);
+ cleanupPwdListeners(
+ new Error(`Failed to write pwd command: ${err.message}`),
+ );
}
- });
- }
-
- // --- Truncate Output (unchanged) ---
- private truncateOutput(output: string, limit?: number): string {
- const effectiveLimit = limit ?? this.outputLimit;
- if (output.length > effectiveLimit) {
- return output.substring(0, effectiveLimit) + `\n... [Output truncated at ${effectiveLimit} characters]`;
+ });
+ } else {
+ throw new Error('Shell stdin not writable for pwd command.');
}
- return output;
- }
+ } catch (e: any) {
+ console.error('Exception writing pwd command:', e);
+ cleanupPwdListeners(
+ new Error(`Exception writing pwd command: ${e.message}`),
+ );
+ }
+ });
+ }
- // --- Clear Queue (unchanged) ---
- private clearQueue(error: Error) {
- const queuedCount = this.commandQueue.length;
- const queue = this.commandQueue;
- this.commandQueue = [];
- queue.forEach(({ resolve, params }) => resolve({
- llmContent: `Command cancelled: ${params.command}\nReason: ${error.message}`,
- returnDisplay: `Command Cancelled: ${error.message}`
- }));
+ // --- Truncate Output (unchanged) ---
+ private truncateOutput(output: string, limit?: number): string {
+ const effectiveLimit = limit ?? this.outputLimit;
+ if (output.length > effectiveLimit) {
+ return (
+ output.substring(0, effectiveLimit) +
+ `\n... [Output truncated at ${effectiveLimit} characters]`
+ );
}
+ return output;
+ }
- // --- Destroy (Added cleanup for pending background tasks if possible) ---
- destroy() {
- // Reject any pending shell readiness promise
- this.rejectShellReady?.(new Error("BashTool destroyed during initialization or operation."));
- this.rejectShellReady = undefined; // Prevent further calls
- this.resolveShellReady = undefined;
+ // --- Clear Queue (unchanged) ---
+ private clearQueue(error: Error) {
+ const queuedCount = this.commandQueue.length;
+ const queue = this.commandQueue;
+ this.commandQueue = [];
+ queue.forEach(({ resolve, params }) =>
+ resolve({
+ llmContent: `Command cancelled: ${params.command}\nReason: ${error.message}`,
+ returnDisplay: `Command Cancelled: ${error.message}`,
+ }),
+ );
+ }
- this.clearQueue(new Error("BashTool is being destroyed."));
+ // --- Destroy (Added cleanup for pending background tasks if possible) ---
+ destroy() {
+ // Reject any pending shell readiness promise
+ this.rejectShellReady?.(
+ new Error('BashTool destroyed during initialization or operation.'),
+ );
+ this.rejectShellReady = undefined; // Prevent further calls
+ this.resolveShellReady = undefined;
- // Attempt to cleanup listeners for the *currently executing* command, if any
- try {
- this.currentCommandCleanup?.();
- } catch (e) {
- console.warn("Error during current command cleanup:", e)
- }
+ this.clearQueue(new Error('BashTool is being destroyed.'));
- // Handle the bash process itself
- if (this.bashProcess) {
- const proc = this.bashProcess; // Reference before nullifying
- const pid = proc.pid;
- this.bashProcess = null; // Nullify reference immediately
+ // Attempt to cleanup listeners for the *currently executing* command, if any
+ try {
+ this.currentCommandCleanup?.();
+ } catch (e) {
+ console.warn('Error during current command cleanup:', e);
+ }
- proc.stdout?.removeAllListeners();
- proc.stderr?.removeAllListeners();
- proc.removeAllListeners('error');
- proc.removeAllListeners('close');
+ // Handle the bash process itself
+ if (this.bashProcess) {
+ const proc = this.bashProcess; // Reference before nullifying
+ const pid = proc.pid;
+ this.bashProcess = null; // Nullify reference immediately
- // Ensure stdin is closed
- proc.stdin?.end();
+ proc.stdout?.removeAllListeners();
+ proc.stderr?.removeAllListeners();
+ proc.removeAllListeners('error');
+ proc.removeAllListeners('close');
- try {
- // Don't wait for these, just attempt
- proc.kill('SIGTERM'); // Attempt graceful first
- setTimeout(() => {
- if (!proc.killed) {
- proc.kill('SIGKILL'); // Force kill if needed
- }
- }, 500); // 500ms grace period
+ // Ensure stdin is closed
+ proc.stdin?.end();
- } catch (e: any) {
- // Catch errors if process already exited etc.
- console.warn(`Error trying to kill bash process PID: ${pid}: ${e.message}`);
- }
- } else {
- }
-
- // Note: We cannot reliably clean up temp files for background tasks
- // that were polling when destroy() was called without more complex state tracking.
- // OS should eventually clean /tmp, or implement a startup cleanup routine if needed.
+ try {
+ // Don't wait for these, just attempt
+ proc.kill('SIGTERM'); // Attempt graceful first
+ setTimeout(() => {
+ if (!proc.killed) {
+ proc.kill('SIGKILL'); // Force kill if needed
+ }
+ }, 500); // 500ms grace period
+ } catch (e: any) {
+ // Catch errors if process already exited etc.
+ console.warn(
+ `Error trying to kill bash process PID: ${pid}: ${e.message}`,
+ );
+ }
+ } else {
}
-} // End of TerminalTool class \ No newline at end of file
+
+ // Note: We cannot reliably clean up temp files for background tasks
+ // that were polling when destroy() was called without more complex state tracking.
+ // OS should eventually clean /tmp, or implement a startup cleanup routine if needed.
+ }
+} // End of TerminalTool class
diff --git a/packages/cli/src/tools/tool-registry.ts b/packages/cli/src/tools/tool-registry.ts
index 48030397..a27d09b9 100644
--- a/packages/cli/src/tools/tool-registry.ts
+++ b/packages/cli/src/tools/tool-registry.ts
@@ -2,56 +2,58 @@ import { ToolListUnion, FunctionDeclaration } from '@google/genai';
import { Tool } from './tools.js';
class ToolRegistry {
- private tools: Map<string, Tool> = new Map();
+ private tools: Map<string, Tool> = new Map();
- /**
- * Registers a tool definition.
- * @param tool - The tool object containing schema and execution logic.
- */
- registerTool(tool: Tool): void {
- if (this.tools.has(tool.name)) {
- // Decide on behavior: throw error, log warning, or allow overwrite
- console.warn(`Tool with name "${tool.name}" is already registered. Overwriting.`);
- }
- this.tools.set(tool.name, tool);
+ /**
+ * Registers a tool definition.
+ * @param tool - The tool object containing schema and execution logic.
+ */
+ registerTool(tool: Tool): void {
+ if (this.tools.has(tool.name)) {
+ // Decide on behavior: throw error, log warning, or allow overwrite
+ console.warn(
+ `Tool with name "${tool.name}" is already registered. Overwriting.`,
+ );
}
+ this.tools.set(tool.name, tool);
+ }
- /**
- * Retrieves the list of tool schemas in the format required by Gemini.
- * @returns A ToolListUnion containing the function declarations.
- */
- getToolSchemas(): ToolListUnion {
- const declarations: FunctionDeclaration[] = [];
- this.tools.forEach(tool => {
- declarations.push(tool.schema);
- });
+ /**
+ * Retrieves the list of tool schemas in the format required by Gemini.
+ * @returns A ToolListUnion containing the function declarations.
+ */
+ getToolSchemas(): ToolListUnion {
+ const declarations: FunctionDeclaration[] = [];
+ this.tools.forEach((tool) => {
+ declarations.push(tool.schema);
+ });
- // Return Gemini's expected format. Handle the case of no tools.
- if (declarations.length === 0) {
- // Depending on the SDK version, you might need `undefined`, `[]`, or `[{ functionDeclarations: [] }]`
- // Check the documentation for your @google/genai version.
- // Let's assume an empty array works or signifies no tools.
- return [];
- // Or if it requires the structure:
- // return [{ functionDeclarations: [] }];
- }
- return [{ functionDeclarations: declarations }];
+ // Return Gemini's expected format. Handle the case of no tools.
+ if (declarations.length === 0) {
+ // Depending on the SDK version, you might need `undefined`, `[]`, or `[{ functionDeclarations: [] }]`
+ // Check the documentation for your @google/genai version.
+ // Let's assume an empty array works or signifies no tools.
+ return [];
+ // Or if it requires the structure:
+ // return [{ functionDeclarations: [] }];
}
+ return [{ functionDeclarations: declarations }];
+ }
- /**
- * Optional: Get a list of registered tool names.
- */
- listAvailableTools(): string[] {
- return Array.from(this.tools.keys());
- }
+ /**
+ * Optional: Get a list of registered tool names.
+ */
+ listAvailableTools(): string[] {
+ return Array.from(this.tools.keys());
+ }
- /**
- * Get the definition of a specific tool.
- */
- getTool(name: string): Tool | undefined {
- return this.tools.get(name);
- }
+ /**
+ * Get the definition of a specific tool.
+ */
+ getTool(name: string): Tool | undefined {
+ return this.tools.get(name);
+ }
}
// Export a singleton instance of the registry
-export const toolRegistry = new ToolRegistry(); \ No newline at end of file
+export const toolRegistry = new ToolRegistry();
diff --git a/packages/cli/src/tools/tools.ts b/packages/cli/src/tools/tools.ts
index 21dd88d5..74acb919 100644
--- a/packages/cli/src/tools/tools.ts
+++ b/packages/cli/src/tools/tools.ts
@@ -1,10 +1,13 @@
-import { FunctionDeclaration, Schema } from "@google/genai";
-import { ToolCallConfirmationDetails } from "../ui/types.js";
+import { FunctionDeclaration, Schema } from '@google/genai';
+import { ToolCallConfirmationDetails } from '../ui/types.js';
/**
* Interface representing the base Tool functionality
*/
-export interface Tool<TParams = unknown, TResult extends ToolResult = ToolResult> {
+export interface Tool<
+ TParams = unknown,
+ TResult extends ToolResult = ToolResult,
+> {
/**
* The internal name of the tool (used for API calls)
*/
@@ -45,7 +48,9 @@ export interface Tool<TParams = unknown, TResult extends ToolResult = ToolResult
* @param params Parameters for the tool execution
* @returns Whether execute should be confirmed.
*/
- shouldConfirmExecute(params: TParams): Promise<ToolCallConfirmationDetails | false>;
+ shouldConfirmExecute(
+ params: TParams,
+ ): Promise<ToolCallConfirmationDetails | false>;
/**
* Executes the tool with the given parameters
@@ -55,11 +60,14 @@ export interface Tool<TParams = unknown, TResult extends ToolResult = ToolResult
execute(params: TParams): Promise<TResult>;
}
-
/**
* Base implementation for tools with common functionality
*/
-export abstract class BaseTool<TParams = unknown, TResult extends ToolResult = ToolResult> implements Tool<TParams, TResult> {
+export abstract class BaseTool<
+ TParams = unknown,
+ TResult extends ToolResult = ToolResult,
+> implements Tool<TParams, TResult>
+{
/**
* Creates a new instance of BaseTool
* @param name Internal name of the tool (used for API calls)
@@ -71,7 +79,7 @@ export abstract class BaseTool<TParams = unknown, TResult extends ToolResult = T
public readonly name: string,
public readonly displayName: string,
public readonly description: string,
- public readonly parameterSchema: Record<string, unknown>
+ public readonly parameterSchema: Record<string, unknown>,
) {}
/**
@@ -81,7 +89,7 @@ export abstract class BaseTool<TParams = unknown, TResult extends ToolResult = T
return {
name: this.name,
description: this.description,
- parameters: this.parameterSchema as Schema
+ parameters: this.parameterSchema as Schema,
};
}
@@ -112,7 +120,9 @@ export abstract class BaseTool<TParams = unknown, TResult extends ToolResult = T
* @param params Parameters for the tool execution
* @returns Whether or not execute should be confirmed by the user.
*/
- shouldConfirmExecute(params: TParams): Promise<ToolCallConfirmationDetails | false> {
+ shouldConfirmExecute(
+ params: TParams,
+ ): Promise<ToolCallConfirmationDetails | false> {
return Promise.resolve(false);
}
@@ -125,7 +135,6 @@ export abstract class BaseTool<TParams = unknown, TResult extends ToolResult = T
abstract execute(params: TParams): Promise<TResult>;
}
-
export interface ToolResult {
/**
* Content meant to be included in LLM history.
@@ -143,5 +152,5 @@ export interface ToolResult {
export type ToolResultDisplay = string | FileDiff;
export interface FileDiff {
- fileDiff: string
+ fileDiff: string;
}
diff --git a/packages/cli/src/tools/write-file.tool.ts b/packages/cli/src/tools/write-file.tool.ts
index 78f14440..8cf0a422 100644
--- a/packages/cli/src/tools/write-file.tool.ts
+++ b/packages/cli/src/tools/write-file.tool.ts
@@ -3,7 +3,11 @@ import path from 'path';
import { BaseTool, ToolResult } from './tools.js';
import { SchemaValidator } from '../utils/schemaValidator.js';
import { makeRelative, shortenPath } from '../utils/paths.js';
-import { ToolCallConfirmationDetails, ToolConfirmationOutcome, ToolEditConfirmationDetails } from '../ui/types.js';
+import {
+ ToolCallConfirmationDetails,
+ ToolConfirmationOutcome,
+ ToolEditConfirmationDetails,
+} from '../ui/types.js';
import * as Diff from 'diff';
/**
@@ -24,13 +28,15 @@ export interface WriteFileToolParams {
/**
* Standardized result from the WriteFile tool
*/
-export interface WriteFileToolResult extends ToolResult {
-}
+export interface WriteFileToolResult extends ToolResult {}
/**
* Implementation of the WriteFile tool that writes files to the filesystem
*/
-export class WriteFileTool extends BaseTool<WriteFileToolParams, WriteFileToolResult> {
+export class WriteFileTool extends BaseTool<
+ WriteFileToolParams,
+ WriteFileToolResult
+> {
public static readonly Name: string = 'write_file';
private shouldAlwaysWrite = false;
@@ -52,17 +58,18 @@ export class WriteFileTool extends BaseTool<WriteFileToolParams, WriteFileToolRe
{
properties: {
filePath: {
- description: 'The absolute path to the file to write to (e.g., \'/home/user/project/file.txt\'). Relative paths are not supported.',
- type: 'string'
+ description:
+ "The absolute path to the file to write to (e.g., '/home/user/project/file.txt'). Relative paths are not supported.",
+ type: 'string',
},
content: {
description: 'The content to write to the file.',
- type: 'string'
- }
+ type: 'string',
+ },
},
required: ['filePath', 'content'],
- type: 'object'
- }
+ type: 'object',
+ },
);
// Set the root directory
@@ -83,7 +90,10 @@ export class WriteFileTool extends BaseTool<WriteFileToolParams, WriteFileToolRe
? normalizedRoot
: normalizedRoot + path.sep;
- return normalizedPath === normalizedRoot || normalizedPath.startsWith(rootWithSep);
+ return (
+ normalizedPath === normalizedRoot ||
+ normalizedPath.startsWith(rootWithSep)
+ );
}
/**
@@ -92,7 +102,13 @@ export class WriteFileTool extends BaseTool<WriteFileToolParams, WriteFileToolRe
* @returns True if parameters are valid, false otherwise
*/
invalidParams(params: WriteFileToolParams): string | null {
- if (this.schema.parameters && !SchemaValidator.validate(this.schema.parameters as Record<string, unknown>, params)) {
+ if (
+ this.schema.parameters &&
+ !SchemaValidator.validate(
+ this.schema.parameters as Record<string, unknown>,
+ params,
+ )
+ ) {
return 'Parameters failed schema validation.';
}
@@ -114,7 +130,9 @@ export class WriteFileTool extends BaseTool<WriteFileToolParams, WriteFileToolRe
* @param params Parameters for the tool execution
* @returns Whether or not execute should be confirmed by the user.
*/
- async shouldConfirmExecute(params: WriteFileToolParams): Promise<ToolCallConfirmationDetails | false> {
+ async shouldConfirmExecute(
+ params: WriteFileToolParams,
+ ): Promise<ToolCallConfirmationDetails | false> {
if (this.shouldAlwaysWrite) {
return false;
}
@@ -135,7 +153,7 @@ export class WriteFileTool extends BaseTool<WriteFileToolParams, WriteFileToolRe
params.content,
'Current',
'Proposed',
- { context: 3, ignoreWhitespace: true}
+ { context: 3, ignoreWhitespace: true },
);
const confirmationDetails: ToolEditConfirmationDetails = {
@@ -171,7 +189,7 @@ export class WriteFileTool extends BaseTool<WriteFileToolParams, WriteFileToolRe
if (validationError) {
return {
llmContent: `Error: Invalid parameters provided. Reason: ${validationError}`,
- returnDisplay: '**Error:** Failed to execute tool.'
+ returnDisplay: '**Error:** Failed to execute tool.',
};
}
@@ -187,13 +205,13 @@ export class WriteFileTool extends BaseTool<WriteFileToolParams, WriteFileToolRe
return {
llmContent: `Successfully wrote to file: ${params.file_path}`,
- returnDisplay: `Wrote to ${shortenPath(makeRelative(params.file_path, this.rootDirectory))}`
+ returnDisplay: `Wrote to ${shortenPath(makeRelative(params.file_path, this.rootDirectory))}`,
};
} catch (error) {
const errorMsg = `Error writing to file: ${error instanceof Error ? error.message : String(error)}`;
return {
llmContent: `Error writing to file ${params.file_path}: ${errorMsg}`,
- returnDisplay: `Failed to write to file: ${errorMsg}`
+ returnDisplay: `Failed to write to file: ${errorMsg}`,
};
}
}
generated by cgit v1.2.3 (git 2.51.0) at 2025-11-05 06:14:52 +0000