mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-11 09:08:31 +00:00
86f9226be7
* fix: fix tool publisher logger when available_exports is found * docs: update docs and templates since we support Python 3.13
57 lines
2.3 KiB
Markdown
57 lines
2.3 KiB
Markdown
# {{crew_name}} Crew
|
|
|
|
Welcome to the {{crew_name}} Crew project, powered by [crewAI](https://crewai.com). 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](https://docs.astral.sh/uv/) for dependency management and package handling, offering a seamless setup and execution experience.
|
|
|
|
First, if you haven't already, install uv:
|
|
|
|
```bash
|
|
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:
|
|
```bash
|
|
crewai install
|
|
```
|
|
|
|
### Customizing
|
|
|
|
**Add your `OPENAI_API_KEY` into the `.env` file**
|
|
|
|
- Modify `src/{{folder_name}}/config/agents.yaml` to define your agents
|
|
- Modify `src/{{folder_name}}/config/tasks.yaml` to define your tasks
|
|
- Modify `src/{{folder_name}}/crew.py` to add your own logic, tools and specific args
|
|
- Modify `src/{{folder_name}}/main.py` to 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:
|
|
|
|
```bash
|
|
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](https://docs.crewai.com)
|
|
- Reach out to us through our [GitHub repository](https://github.com/joaomdmoura/crewai)
|
|
- [Join our Discord](https://discord.com/invite/X4JWnZnxPb)
|
|
- [Chat with our docs](https://chatg.pt/DWjSBZn)
|
|
|
|
Let's create wonders together with the power and simplicity of crewAI.
|