mirror of https://github.com/crewAIInc/crewAI.git synced 2026-07-08 16:35:08 +00:00

Files

Greyson Lalonde bada7fd909 chore: merge main into gl/chore/refactor-cli

Resolve conflicts from origin/main: relocate new CLI additions
(checkpoint_tui, deploy/validate, remote_template, content_crew
templates) into lib/cli, rewrite imports for the standalone
crewai-cli package, port main's trained_agents_file param and
predeploy validation, and bump python-dotenv/pydantic in
crewai-cli to match crewai's constraints. Add the new
mark_ephemeral_trace_batch_as_failed method to the relocated
crewai.plus_api. Update tests for the new payload field, deploy
--skip-validate kwarg, and crewai_cli import paths.

2026-05-05 02:00:39 +08:00

2.3 KiB

Raw Blame History

{{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.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:

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.

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.

2.3 KiB Raw Blame History