diff --git a/README.md b/README.md index 1e393f5e9..17d1fcd3e 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,69 @@ -# crewAI +
-![Logo of crewAI, tow people rowing on a boat](./docs/crewai_logo.png) +![Logo of crewAI, two people rowing on a boat](./docs/crewai_logo.png) -🤖 Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks. +# **crewAI** -- [crewAI](#crewai) - - [Why CrewAI?](#why-crewai) - - [Getting Started](#getting-started) - - [Key Features](#key-features) - - [Examples](#examples) - - [Code](#code) - - [Video](#video) - - [Quick Tutorial](#quick-tutorial) - - [Trip Planner](#trip-planner) - - [Stock Analysis](#stock-analysis) - - [Connecting Your Crew to a Model](#connecting-your-crew-to-a-model) - - [How CrewAI Compares](#how-crewai-compares) - - [Contribution](#contribution) - - [Installing Dependencies](#installing-dependencies) - - [Virtual Env](#virtual-env) - - [Pre-commit hooks](#pre-commit-hooks) - - [Running Tests](#running-tests) - - [Packaging](#packaging) - - [Installing Locally](#installing-locally) - - [Hire CrewAI](#hire-crewai) - - [License](#license) +🤖 **crewAI**: Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks. + +

+ +[Homepage](https://www.crewai.io/) | [Documentation](https://joaomdmoura.github.io/crewAI/) | [Chat with Docs](https://chatg.pt/DWjSBZn) | [Examples](https://joaomdmoura.github.io/crewAI/#examples-and-tutorials) | [Discord](https://discord.com/invite/X4JWnZnxPb) + +

+ +[![GitHub Repo stars](https://img.shields.io/github/stars/joaomdmoura/crewAI)](https://github.com/joaomdmoura/crewAI) +[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) + + + +
+ +## Table of contents + +- [Why CrewAI?](#why-crewai) +- [Getting Started](#getting-started) +- [Key Features](#key-features) +- [Examples](#examples) + - [Quick Tutorial](#quick-tutorial) + - [Trip Planner](#trip-planner) + - [Stock Analysis](#stock-analysis) +- [Connecting Your Crew to a Model](#connecting-your-crew-to-a-model) +- [How CrewAI Compares](#how-crewai-compares) +- [Contribution](#contribution) +- [Hire CrewAI](#hire-crewai) +- [License](#license) ## Why CrewAI? The power of AI collaboration has too much to offer. CrewAI is designed to enable AI agents to assume roles, share goals, and operate in a cohesive unit - much like a well-oiled crew. Whether you're building a smart assistant platform, an automated customer service ensemble, or a multi-agent research team, CrewAI provides the backbone for sophisticated multi-agent interactions. -- 🤖 [Talk with the Docs](https://chatg.pt/DWjSBZn) -- 📄 [Documentation Wiki](https://joaomdmoura.github.io/crewAI/) - ## Getting Started To get started with CrewAI, follow these simple steps: -1. **Installation**: +### 1. Installation ```shell pip install crewai ``` -The example below also uses duckduckgo, so also install that +The example below also uses DuckDuckGo's Search. You can install it with `pip` too: + ```shell pip install duckduckgo-search ``` -2. **Setting Up Your Crew**: +### 2. Setting Up Your Crew ```python import os from crewai import Agent, Task, Crew, Process -os.environ["OPENAI_API_KEY"] = "YOUR KEY" +os.environ["OPENAI_API_KEY"] = "YOUR_API_KEY" -# You can choose to use a local model through Ollama for example. See ./docs/llm-connections.md for more information. +# You can choose to use a local model through Ollama for example. See ./docs/how-to/llm-connections.md for more information. # from langchain.llms import Ollama # ollama_llm = Ollama(model="openhermes") @@ -73,8 +79,7 @@ researcher = Agent( goal='Uncover cutting-edge developments in AI and data science', backstory="""You work at a leading tech think tank. Your expertise lies in identifying emerging trends. - You have a knack for dissecting complex data and presenting - actionable insights.""", + You have a knack for dissecting complex data and presenting actionable insights.""", verbose=True, allow_delegation=False, tools=[search_tool] @@ -91,8 +96,7 @@ researcher = Agent( writer = Agent( role='Tech Content Strategist', goal='Craft compelling content on tech advancements', - backstory="""You are a renowned Content Strategist, known for - your insightful and engaging articles. + backstory="""You are a renowned Content Strategist, known for your insightful and engaging articles. You transform complex concepts into compelling narratives.""", verbose=True, allow_delegation=True, @@ -130,8 +134,7 @@ print("######################") print(result) ``` -In addition to the sequential process, you can use the hierarchical process, which automatically assigns a manager to the defined crew to properly coordinate the planning and execution of tasks through delegation and validation of results. See more about the processes [here](./docs/core-concepts/Managing-Processes.md) - +In addition to the sequential process, you can use the hierarchical process, which automatically assigns a manager to the defined crew to properly coordinate the planning and execution of tasks through delegation and validation of results. See more about the processes [here](./docs/core-concepts/Managing-Processes.md). ## Key Features @@ -139,28 +142,34 @@ In addition to the sequential process, you can use the hierarchical process, whi - **Autonomous Inter-Agent Delegation**: Agents can autonomously delegate tasks and inquire amongst themselves, enhancing problem-solving efficiency. - **Flexible Task Management**: Define tasks with customizable tools and assign them to agents dynamically. - **Processes Driven**: Currently only supports `sequential` task execution and `hierarchical` processes, but more complex processes like consensual and autonomous are being worked on. -- **Works with Open Source Models**: Run your crew using Open AI or open source models refer to the [Connect crewAI to LLMs](./docs/llm-connections.md) page for details on configuring you agents' connections to models, even ones running locally! +- **Works with Open Source Models**: Run your crew using Open AI or open source models refer to the [Connect crewAI to LLMs](https://joaomdmoura.github.io/crewAI/how-to/LLM-Connections/) page for details on configuring you agents' connections to models, even ones running locally! ![CrewAI Mind Map](./docs/crewAI-mindmap.png "CrewAI Mind Map") ## Examples -You can test different real life examples of AI crews [in the examples repo](https://github.com/joaomdmoura/crewAI-examples?tab=readme-ov-file) -### Code -- [Trip Planner](https://github.com/joaomdmoura/crewAI-examples/tree/main/trip_planner) -- [Stock Analysis](https://github.com/joaomdmoura/crewAI-examples/tree/main/stock_analysis) +You can test different real life examples of AI crews in the [ `crewAI-examples`](https://github.com/joaomdmoura/crewAI-examples?tab=readme-ov-file) repo: + - [Landing Page Generator](https://github.com/joaomdmoura/crewAI-examples/tree/main/landing_page_generator) - [Having Human input on the execution](./docs/how-to/Human-Input-on-Execution.md) +- [Trip Planner](https://github.com/joaomdmoura/crewAI-examples/tree/main/trip_planner) +- [Stock Analysis](https://github.com/joaomdmoura/crewAI-examples/tree/main/stock_analysis) -### Video -#### Quick Tutorial -[![CrewAI Tutorial](https://img.youtube.com/vi/tnejrr-0a94/0.jpg)](https://www.youtube.com/watch?v=tnejrr-0a94 "CrewAI Tutorial") +### Quick Tutorial -#### Trip Planner -[![Trip Planner](https://img.youtube.com/vi/xis7rWp-hjs/0.jpg)](https://www.youtube.com/watch?v=xis7rWp-hjs "Trip Planner") +[![CrewAI Tutorial](https://img.youtube.com/vi/tnejrr-0a94/maxresdefault.jpg)](https://www.youtube.com/watch?v=tnejrr-0a94 "CrewAI Tutorial") -#### Stock Analysis -[![Stock Analysis](https://img.youtube.com/vi/e0Uj4yWdaAg/0.jpg)](https://www.youtube.com/watch?v=e0Uj4yWdaAg "Stock Analysis") +### Trip Planner + +[Check out code for this example](https://github.com/joaomdmoura/crewAI-examples/tree/main/trip_planner) or watch a video below: + +[![Trip Planner](https://img.youtube.com/vi/xis7rWp-hjs/maxresdefault.jpg)](https://www.youtube.com/watch?v=xis7rWp-hjs "Trip Planner") + +### Stock Analysis + +[Check out code for this example](https://github.com/joaomdmoura/crewAI-examples/tree/main/stock_analysis) or watch a video below: + +[![Stock Analysis](https://img.youtube.com/vi/e0Uj4yWdaAg/maxresdefault.jpg)](https://www.youtube.com/watch?v=e0Uj4yWdaAg "Stock Analysis") ## Connecting Your Crew to a Model @@ -187,12 +196,14 @@ CrewAI is open-source and we welcome contributions. If you're looking to contrib - We appreciate your input! ### Installing Dependencies + ```bash poetry lock poetry install ``` ### Virtual Env + ```bash poetry shell ``` @@ -204,28 +215,34 @@ pre-commit install ``` ### Running Tests + ```bash poetry run pytest ``` ### Running static type checks + ```bash poetry run pyright ``` ### Packaging + ```bash poetry build ``` ### Installing Locally + ```bash pip install dist/*.tar.gz ``` ## Hire CrewAI + We're a company developing crewAI and crewAI Enterprise, we for a limited time are offer consulting with selected customers, to get them early access to our enterprise solution -If you are interested on having access to it and hiring weekly hours with our team, feel free to email us at [sales@crewai.io](mailto:sales@crewai.io) +If you are interested on having access to it and hiring weekly hours with our team, feel free to email us at [sales@crewai.io](mailto:sales@crewai.io). ## License -CrewAI is released under the MIT License + +CrewAI is released under the MIT License.