bf8fbb0a44
* fix: fix tool publisher logger when available_exports is found * docs: update docs and templates since we support Python 3.13
2.3 KiB
{{crew_name}} Crew
Welcome to the {{crew_name}} Crew project, powered by crewAI. This template is designed to help you set up a multi-agent AI system with ease, leveraging the powerful and flexible framework provided by crewAI. Our goal is to enable your agents to collaborate effectively on complex tasks, maximizing their collective intelligence and capabilities.
Installation
Ensure you have Python >=3.10 <3.14 installed on your system. This project uses UV for dependency management and package handling, offering a seamless setup and execution experience.
First, if you haven't already, install uv:
pip install uv
Next, navigate to your project directory and install the dependencies:
(Optional) Lock the dependencies and install them by using the CLI command:
crewai install
Customizing
Add your OPENAI_API_KEY into the .env file
- Modify
src/{{folder_name}}/config/agents.yamlto define your agents - Modify
src/{{folder_name}}/config/tasks.yamlto define your tasks - Modify
src/{{folder_name}}/crew.pyto add your own logic, tools and specific args - Modify
src/{{folder_name}}/main.pyto add custom inputs for your agents and tasks
Running the Project
To kickstart your flow and begin execution, run this from the root folder of your project:
crewai run
This command initializes the {{name}} Flow as defined in your configuration.
This example, unmodified, will run the create a report.md file with the output of a research on LLMs in the root folder.
Understanding Your Crew
The {{name}} Crew is composed of multiple AI agents, each with unique roles, goals, and tools. These agents collaborate on a series of tasks, defined in config/tasks.yaml, leveraging their collective skills to achieve complex objectives. The config/agents.yaml file outlines the capabilities and configurations of each agent in your crew.
Support
For support, questions, or feedback regarding the {{crew_name}} Crew or crewAI.
- Visit our documentation
- Reach out to us through our GitHub repository
- Join our Discord
- Chat with our docs
Let's create wonders together with the power and simplicity of crewAI.