GrepTool

Generated by TypeDoc. Do not edit this page directly.

API Reference

---

Class: GrepTool

Defined in: packages/tools-node/src/files.ts:197

Extends

• HarnessTool<GrepInput, { matches: string[]; }>

Constructors

Constructor

new GrepTool(): GrepTool;

Returns

GrepTool

Inherited from

HarnessTool.constructor

Properties

Property	Type	Default value	Overrides	Inherited from	Defined in
approvalTimeoutMs?	number	undefined	-	HarnessTool.approvalTimeoutMs	packages/core/src/runtime/types/tools.ts:55
description	string	"Search text files inside workDir using plain text or an extended grep RegExp."	HarnessTool.description	-	packages/tools-node/src/files.ts:199
label?	string	undefined	-	HarnessTool.label	packages/core/src/runtime/types/tools.ts:48
name	string	"grep"	HarnessTool.name	-	packages/tools-node/src/files.ts:198
permissions	object[]	undefined	HarnessTool.permissions	-	packages/tools-node/src/files.ts:202
requiresApproval?	| boolean | ToolApprovalResolver	undefined	-	HarnessTool.requiresApproval	packages/core/src/runtime/types/tools.ts:54
risk	"read"	undefined	HarnessTool.risk	-	packages/tools-node/src/files.ts:201
schema	ObjectSchema<{ maxResults: DefaultSchema<unknown, number>; path: DefaultSchema<unknown, string>; pattern: StringSchema; regex: DefaultSchema<unknown, boolean>; }>	grepSchema	HarnessTool.schema	-	packages/tools-node/src/files.ts:200

Accessors

inputSchema

Get Signature

get inputSchema(): unknown;

Defined in: packages/core/src/runtime/types/tools.ts:61

Returns

unknown

Inherited from

HarnessTool.inputSchema

---

type

Get Signature

get type(): string;

Defined in: packages/core/src/runtime/types/tools.ts:57

Returns

string

Inherited from

HarnessTool.type

Methods

execute()

execute(args, session): Promise<AgentToolResult<{
  matches: string[];
}>>;

Defined in: packages/tools-node/src/files.ts:204

Parameters

Parameter	Type
args	ObjectInput
session	AgentActionSession

Returns

Promise<AgentToolResult<{ matches: string[]; }>>

Overrides

HarnessTool.execute