/crewai_xhs

Primary LanguagePython

XhsWriter Crew

Welcome to the XhsWriter 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.13 installed on your system. This project uses Poetry for dependency management and package handling, offering a seamless setup and execution experience.

First, if you haven't already, install Poetry:

pip install poetry

Next, navigate to your project directory and install the dependencies:

  1. First lock the dependencies and then install them:
poetry lock
poetry install

Customizing

Add your OPENAI_API_KEY into the .env file

  • Modify src/xhs_writer/config/agents.yaml to define your agents
  • Modify src/xhs_writer/config/tasks.yaml to define your tasks
  • Modify src/xhs_writer/crew.py to add your own logic, tools and specific args
  • Modify src/xhs_writer/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:

poetry run xhs_writer

This command initializes the xhs_writer 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 xhs_writer 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 XhsWriter Crew or crewAI.

Let's create wonders together with the power and simplicity of crewAI.