mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 08:08:32 +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
45 lines
1.5 KiB
Plaintext
45 lines
1.5 KiB
Plaintext
---
|
|
title: File Read
|
|
description: The `FileReadTool` is designed to read files from the local file system.
|
|
icon: folders
|
|
mode: "wide"
|
|
---
|
|
|
|
## Overview
|
|
|
|
<Note>
|
|
We are still working on improving tools, so there might be unexpected behavior or changes in the future.
|
|
</Note>
|
|
|
|
The FileReadTool conceptually represents a suite of functionalities within the crewai_tools package aimed at facilitating file reading and content retrieval.
|
|
This suite includes tools for processing batch text files, reading runtime configuration files, and importing data for analytics.
|
|
It supports a variety of text-based file formats such as `.txt`, `.csv`, `.json`, and more. Depending on the file type, the suite offers specialized functionality,
|
|
such as converting JSON content into a Python dictionary for ease of use.
|
|
|
|
## Installation
|
|
|
|
To utilize the functionalities previously attributed to the FileReadTool, install the crewai_tools package:
|
|
|
|
```shell
|
|
pip install 'crewai[tools]'
|
|
```
|
|
|
|
## Usage Example
|
|
|
|
To get started with the FileReadTool:
|
|
|
|
```python Code
|
|
from crewai_tools import FileReadTool
|
|
|
|
# Initialize the tool to read any files the agents knows or lean the path for
|
|
file_read_tool = FileReadTool()
|
|
|
|
# OR
|
|
|
|
# Initialize the tool with a specific file path, so the agent can only read the content of the specified file
|
|
file_read_tool = FileReadTool(file_path='path/to/your/file.txt')
|
|
```
|
|
|
|
## Arguments
|
|
|
|
- `file_path`: The path to the file you want to read. It accepts both absolute and relative paths. Ensure the file exists and you have the necessary permissions to access it. |