多文件读取工具 (read_many_files)

本文档介绍了 Gemini CLI 的 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], required): 一个 glob 模式或相对于工具目标目录的路径数组（例如 ["src/**/*.ts"]、["README.md", "docs/*", "assets/logo.png"]）。
• exclude (list[string], optional): 要排除的文件/目录的 glob 模式（例如 ["**/*.log", "temp/"]）。如果 useDefaultExcludes 为 true，这些模式将添加到默认排除项中。
• include (list[string], optional): 要包含的附加 glob 模式。这些模式将与 paths 合并（例如，如果测试文件被广泛排除，则使用 ["*.test.ts"] 来专门添加它们，或者使用 ["images/*.jpg"] 来包含特定的图像类型）。
• recursive (boolean, optional): 是否递归搜索。这主要由 glob 模式中的 ** 控制。默认为 true。
• useDefaultExcludes (boolean, optional): 是否应用一组默认排除模式（例如 node_modules、.git、非图像/PDF 二进制文件）。默认为 true。
• respect_git_ignore (boolean, optional): 在查找文件时是否尊重 .gitignore 模式。默认为 true。

如何在 Gemini CLI 中使用 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=["在此处输入您的文件或路径。"], include=["要包含的附加文件。"], 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，但请谨慎操作。