Skip to content

Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.

docs: document FileWriterTool as solution for file writing issues (#2039)

devin-ai-integration[bot]a79d77dfd78c
diff --git a/docs/tools/filewritetool.mdx b/docs/tools/filewritetool.mdx
index f5dffb2ad..5e00801b7 100644
--- a/docs/tools/filewritetool.mdx
+++ b/docs/tools/filewritetool.mdx
@@ -8,9 +8,9 @@ icon: file-pen
## Description
-The `FileWriterTool` is a component of the crewai_tools package, designed to simplify the process of writing content to files.
+The `FileWriterTool` is a component of the crewai_tools package, designed to simplify the process of writing content to files with cross-platform compatibility (Windows, Linux, macOS).
It is particularly useful in scenarios such as generating reports, saving logs, creating configuration files, and more.
-This tool supports creating new directories if they don't exist, making it easier to organize your output.
+This tool handles path differences across operating systems, supports UTF-8 encoding, and automatically creates directories if they don't exist, making it easier to organize your output reliably across different platforms.
## Installation
@@ -43,6 +43,8 @@ print(result)
## Conclusion
-By integrating the `FileWriterTool` into your crews, the agents can execute the process of writing content to files and creating directories.
-This tool is essential for tasks that require saving output data, creating structured file systems, and more. By adhering to the setup and usage guidelines provided,
-incorporating this tool into projects is straightforward and efficient.
\ No newline at end of file
+By integrating the `FileWriterTool` into your crews, the agents can reliably write content to files across different operating systems.
+This tool is essential for tasks that require saving output data, creating structured file systems, and handling cross-platform file operations.
+It's particularly recommended for Windows users who may encounter file writing issues with standard Python file operations.
+
+By adhering to the setup and usage guidelines provided, incorporating this tool into projects is straightforward and ensures consistent file writing behavior across all platforms.
diff --git a/src/crewai/task.py b/src/crewai/task.py
index a3ee8aa14..4088c3fb0 100644
--- a/src/crewai/task.py
+++ b/src/crewai/task.py
@@ -674,19 +674,32 @@ class Task(BaseModel):
return OutputFormat.PYDANTIC
return OutputFormat.RAW
- def _save_file(self, result: Any) -> None:
+ def _save_file(self, result: Union[Dict, str, Any]) -> None:
"""Save task output to a file.
+ Note:
+ For cross-platform file writing, especially on Windows, consider using FileWriterTool
+ from the crewai_tools package:
+ pip install 'crewai[tools]'
+ from crewai_tools import FileWriterTool
+
Args:
result: The result to save to the file. Can be a dict or any stringifiable object.
Raises:
ValueError: If output_file is not set
- RuntimeError: If there is an error writing to the file
+ RuntimeError: If there is an error writing to the file. For cross-platform
+ compatibility, especially on Windows, use FileWriterTool from crewai_tools
+ package.
"""
if self.output_file is None:
raise ValueError("output_file is not set.")
+ FILEWRITER_RECOMMENDATION = (
+ "For cross-platform file writing, especially on Windows, "
+ "use FileWriterTool from crewai_tools package."
+ )
+
try:
resolved_path = Path(self.output_file).expanduser().resolve()
directory = resolved_path.parent
@@ -702,7 +715,12 @@ class Task(BaseModel):
else:
file.write(str(result))
except (OSError, IOError) as e:
- raise RuntimeError(f"Failed to save output file: {e}")
+ raise RuntimeError(
+ "\n".join([
+ f"Failed to save output file: {e}",
+ FILEWRITER_RECOMMENDATION
+ ])
+ )
return None
def __repr__(self):