mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 16:18:30 +00:00
1a1bb0ca3d
* docs(cli): document device-code login and config reset guidance; renumber sections * docs(cli): fix duplicate numbering (renumber Login/API Keys/Configuration sections) * docs: Fix webhook documentation to include meta dict in all webhook payloads - Add note explaining that meta objects from kickoff requests are included in all webhook payloads - Update webhook examples to show proper payload structure including meta field - Fix webhook examples to match actual API implementation - Apply changes to English, Korean, and Portuguese documentation Resolves the documentation gap where meta dict passing to webhooks was not documented despite being implemented in the API. * WIP: CrewAI docs theme, changelog, GEO, localization * docs(cli): fix merge markers; ensure mode: "wide"; convert ASCII tables to Markdown (en/pt-BR/ko) * docs: add group icons across locales; split Automation/Integrations; update tools overviews and links
54 lines
2.5 KiB
Plaintext
54 lines
2.5 KiB
Plaintext
---
|
|
title: Leitura de Diretório
|
|
description: O `DirectoryReadTool` é uma poderosa utilidade projetada para fornecer uma listagem abrangente do conteúdo de diretórios.
|
|
icon: folder-tree
|
|
mode: "wide"
|
|
---
|
|
|
|
# `DirectoryReadTool`
|
|
|
|
<Note>
|
|
Ainda estamos trabalhando para melhorar as ferramentas, então pode haver comportamentos inesperados ou alterações no futuro.
|
|
</Note>
|
|
|
|
## Descrição
|
|
|
|
O DirectoryReadTool é uma poderosa utilidade projetada para fornecer uma listagem abrangente do conteúdo de diretórios.
|
|
Ele pode navegar recursivamente pelo diretório especificado, oferecendo aos usuários uma enumeração detalhada de todos os arquivos, incluindo aqueles que estão dentro de subdiretórios.
|
|
Essa ferramenta é fundamental para tarefas que exigem um inventário completo das estruturas de diretórios ou para validar a organização de arquivos em diretórios.
|
|
|
|
## Instalação
|
|
|
|
Para utilizar o DirectoryReadTool em seu projeto, instale o pacote `crewai_tools`. Se este pacote ainda não faz parte do seu ambiente, você pode instalá-lo usando o pip com o comando abaixo:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
Esse comando instala a versão mais recente do pacote `crewai_tools`, permitindo o acesso ao DirectoryReadTool, entre outras utilidades.
|
|
|
|
## Exemplo
|
|
|
|
Empregar o DirectoryReadTool é simples. O snippet de código a seguir demonstra como configurá-lo e usar a ferramenta para listar o conteúdo de um diretório especificado:
|
|
|
|
```python Code
|
|
from crewai_tools import DirectoryReadTool
|
|
|
|
# Initialize the tool so the agent can read any directory's content
|
|
# it learns about during execution
|
|
tool = DirectoryReadTool()
|
|
|
|
# OR
|
|
|
|
# Initialize the tool with a specific directory,
|
|
# so the agent can only read the content of the specified directory
|
|
tool = DirectoryReadTool(directory='/path/to/your/directory')
|
|
```
|
|
|
|
## Argumentos
|
|
|
|
Os seguintes parâmetros podem ser usados para personalizar o comportamento do `DirectoryReadTool`:
|
|
|
|
| Argumento | Tipo | Descrição |
|
|
|:---------------|:---------|:----------------------------------------------------------------------------------------------------------------------------------|
|
|
| **directory** | `string` | _Opcional_. Um argumento que especifica o caminho para o diretório cujo conteúdo você deseja listar. Aceita caminhos absolutos e relativos, direcionando a ferramenta para o diretório desejado para a listagem do conteúdo. | |