跳转到主要内容

apply_patch 工具

使用结构化补丁格式应用文件更改。 这非常适合多文件 或多补丁块的编辑,在这种情况下单个 edit 调用会很脆弱。 该工具接受一个 input 字符串,其中包含一个或多个文件操作:
*** Begin Patch
*** Add File: path/to/file.txt
+line 1
+line 2
*** Update File: src/app.ts
@@
-old line
+new line
*** Delete File: obsolete.txt
*** End Patch

参数

  • input(必需):完整的补丁内容,包括 *** Begin Patch*** End Patch

说明

  • Patch 路径支持相对路径(相对于 workspace 目录)和绝对路径。
  • tools.exec.applyPatch.workspaceOnly 默认值为 true(仅限 workspace 内)。 仅当你有意让 apply_patch 在 workspace 目录之外进行写入/删除操作时,才将其设置为 false
  • *** Update File: 段中使用 *** Move to: 可重命名文件。
  • 需要时使用 *** End of File 标记仅在文件末尾的插入。
  • 实验性功能,默认禁用。 实验性功能,默认禁用。通过 tools.exec.applyPatch.enabled 启用。
  • 仅限 OpenAI(包括 OpenAI Codex)。可选通过 tools.exec.applyPatch.allowModels 按模型进行限制。 可选地按模型进行限制: tools.exec.applyPatch.allowModels
  • 配置仅在 tools.exec 下。

示例

{
  "tool": "apply_patch",
  "input": "*** Begin Patch\n*** Update File: src/index.ts\n@@\n-const foo = 1\n+const foo = 2\n*** End Patch"
}