Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lorenzejay/crewai_example_repo
https://github.com/lorenzejay/crewai_example_repo
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/lorenzejay/crewai_example_repo
- Owner: lorenzejay
- Created: 2024-08-23T18:02:16.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-23T19:27:58.000Z (5 months ago)
- Last Synced: 2024-08-23T21:06:25.726Z (5 months ago)
- Language: Python
- Size: 131 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CrewaiExampleRepo Crew
Welcome to the CrewaiExampleRepo 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.13 installed on your system. This project uses [Poetry](https://python-poetry.org/) for dependency management and package handling, offering a seamless setup and execution experience.
First, if you haven't already, install Poetry:
```bash
pip install poetry
```
Next, navigate to your project directory and install the dependencies:
1. First lock the dependencies and then install them:
```bash
poetry lock
```
```bash
poetry install
```
### Customizing
**Add your `OPENAI_API_KEY` into the `.env` file**
- Modify `src/crewai_example_repo/config/agents.yaml` to define your agents
- Modify `src/crewai_example_repo/config/tasks.yaml` to define your tasks
- Modify `src/crewai_example_repo/crew.py` to add your own logic, tools and specific args
- Modify `src/crewai_example_repo/main.py` to add custom inputs for your agents and tasks
## Running the Project
To kickstart your crew of AI agents and begin task execution, run this from the root folder of your project:
```bash
$ crewai run
```
or
```bash
poetry run crewai_example_repo
```
This command initializes the crewai-example-repo Crew, assembling the agents and assigning them tasks 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 crewai-example-repo 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 CrewaiExampleRepo 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.