lib/cli/src/crewai_cli/templates/flow/README.md
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.
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
Add your OPENAI_API_KEY into the .env file
src/{{folder_name}}/config/agents.yaml to define your agentssrc/{{folder_name}}/config/tasks.yaml to define your taskssrc/{{folder_name}}/crew.py to add your own logic, tools and specific argssrc/{{folder_name}}/main.py to add custom inputs for your agents and tasksTo 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 a content creation flow on AI Agents and save the output to output/post.md.
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.
For support, questions, or feedback regarding the {{crew_name}} Crew or crewAI.
Let's create wonders together with the power and simplicity of crewAI.