DirectoryReadTool

实验性

我们仍在改进工具，因此未来可能会有意外行为或变化。

描述

DirectoryReadTool 是一个强大的实用工具，旨在提供目录内容的全面列表。它可以递归地遍历指定目录，为用户提供所有文件的详细枚举，包括子目录中的文件。此工具对于需要彻底盘点目录结构或验证目录中文件组织的任务至关重要。

安装

要在您的项目中使用 DirectoryReadTool，请安装 crewai_tools 包。如果此包尚未成为您环境的一部分，您可以使用以下命令通过 pip 安装它：

pip install 'crewai[tools]'

此命令安装最新版本的 crewai_tools 包，从而可以使用 DirectoryReadTool 及其他实用工具。

示例

使用 DirectoryReadTool 非常简单。以下代码片段展示了如何设置并使用该工具来列出指定目录的内容：

from crewai_tools import DirectoryReadTool

# 初始化工具，以便代理可以在执行期间读取其了解的任何目录的内容
tool = DirectoryReadTool()

# 或者

# 使用特定目录初始化工具，以便代理只能读取指定目录的内容
tool = DirectoryReadTool(directory='/path/to/your/directory')

参数

DirectoryReadTool 需要的配置非常少。此工具的基本参数如下：

• directory：可选。一个指定您希望列出内容的目录路径的参数。它接受绝对路径和相对路径，引导工具到所需目录进行内容列表。