多文件读取工具 (read_many_files)

本文档描述了用于 Qwen Code 的 read_many_files 工具。

描述

使用 read_many_files 从指定路径或 glob 模式匹配的多个文件中读取内容。此工具的行为取决于提供的文件类型：

• 对于文本文件，该工具会将其内容连接成一个单一字符串。
• 对于图像（如 PNG、JPEG）、PDF、音频（MP3、WAV）和视频（MP4、MOV）文件，如果通过文件名或扩展名明确请求，它会以 base64 编码的数据形式读取并返回这些文件。

read_many_files 可用于执行以下任务：概览代码库、查找特定功能的实现位置、审查文档或从多个配置文件中收集上下文信息。

注意： read_many_files 会根据提供的路径或 glob 模式查找文件。像 "/docs" 这样的目录路径将返回空结果；该工具需要类似 "/docs/*" 或 "/docs/*.md" 的模式来识别相关文件。

参数

read_many_files 接受以下参数：

• paths (list[string], 必填): 一个 glob 模式或相对于工具目标目录的路径数组（例如 ["src/**/*.ts"]、["README.md", "docs/*", "assets/logo.png"]）。
• exclude (list[string], 可选): 要排除的文件/目录的 glob 模式（例如 ["**/*.log", "temp/"]）。如果 useDefaultExcludes 为 true，这些模式会与默认排除模式合并。
• include (list[string], 可选): 要包含的额外 glob 模式。这些模式会与 paths 合并（例如 ["*.test.ts"] 用于特别添加测试文件，如果它们被广泛排除；或者 ["images/*.jpg"] 用于包含特定图像类型）。
• recursive (boolean, 可选): 是否递归搜索。这主要由 glob 模式中的 ** 控制。默认为 true。
• useDefaultExcludes (boolean, 可选): 是否应用默认排除模式列表（例如 node_modules、.git、非图像/PDF 的二进制文件）。默认为 true。
• respect_git_ignore (boolean, 可选): 查找文件时是否遵循 .gitignore 模式。默认为 true。

如何在 Qwen Code 中使用 read_many_files

read_many_files 会根据提供的 paths 和 include 模式搜索匹配的文件，同时遵守 exclude 模式和默认排除规则（如果启用）。

• 对于文本文件：它会读取每个匹配文件的内容（尝试跳过未明确指定为图像/PDF 的二进制文件），并将它们连接成一个字符串，每个文件内容之间用分隔符 --- {filePath} --- 分隔。默认使用 UTF-8 编码。
• 工具会在最后一个文件之后插入 --- End of content ---。
• 对于图像和 PDF 文件：如果通过名称或扩展名显式请求（例如 paths: ["logo.png"] 或 include: ["*.pdf"]），工具会读取文件并将其内容作为 base64 编码的字符串返回。
• 工具会尝试检测并跳过其他二进制文件（不匹配常见图像/PDF 类型且未显式请求的文件），方法是检查其初始内容中是否包含空字节。

用法：

read_many_files(paths=["Your files or paths here."], include=["Additional files to include."], exclude=["Files to exclude."], recursive=False, useDefaultExcludes=false, respect_git_ignore=true)

read_many_files 示例

读取 src 目录下的所有 TypeScript 文件：

read_many_files(paths=["src/**/*.ts"])

读取主 README 文件、docs 目录下的所有 Markdown 文件以及一个特定的 logo 图片，但排除一个特定文件：

read_many_files(paths=["README.md", "docs/**/*.md", "assets/logo.png"], exclude=["docs/OLD_README.md"])

读取所有 JavaScript 文件，但显式包含测试文件以及 images 文件夹中的所有 JPEG 图片：

read_many_files(paths=["**/*.js"], include=["**/*.test.js", "images/**/*.jpg"], useDefaultExcludes=False)

重要说明

• 二进制文件处理：
  • 图片/PDF/音频/视频文件： 该工具可以读取常见的图像格式（PNG、JPEG 等）、PDF、音频（mp3、wav）和视频（mp4、mov）文件，并将其作为 base64 编码数据返回。这些文件必须通过 paths 或 include 模式显式指定（例如，指定确切的文件名如 video.mp4 或模式如 *.mov）。
  • 其他二进制文件： 工具会尝试通过检查文件开头内容中是否包含空字节来检测并跳过其他类型的二进制文件。这些文件会被排除在输出之外。
• 性能： 读取大量文件或单个大文件可能会占用较多资源。
• 路径准确性： 确保路径和 glob 模式相对于工具的目标目录正确指定。对于图像/PDF 文件，请确保模式足够具体以包含它们。
• 默认排除项： 注意默认的排除模式（如 node_modules、.git），如果需要覆盖这些默认设置，可以使用 useDefaultExcludes=False，但请谨慎操作。