adding initial CLI support

.pre-commit-config.yaml

@@ -1,11 +1,11 @@
 repos:
-
   - repo: https://github.com/psf/black-pre-commit-mirror
     rev: 23.12.1
     hooks:
       - id: black
         language_version: python3.11
         files: \.(py)$
+        exclude: 'src/crewai/cli/templates/(crew|main)\.py'
 
   - repo: https://github.com/pycqa/isort
     rev: 5.13.2

pyproject.toml

@@ -1,7 +1,6 @@
-
 [tool.poetry]
 name = "crewai"
-version = "0.19.0"
+version = "0.20.0"
 description = "Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks."
 authors = ["Joao Moura <joao@crewai.com>"]
 readme = "README.md"
@@ -56,6 +55,9 @@ pytest = "^8.0.0"
 pytest-vcr = "^1.0.2"
 python-dotenv = "1.0.0"
 
+[tool.poetry.scripts]
+crewai = "crewai.cli.cli:crewai"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"

src/crewai/cli/cli.py

@@ -0,0 +1,19 @@
+import click
+
+from .create_crew import create_crew
+
+
+@click.group()
+def crewai():
+    """Top-level command group for crewai."""
+
+
+@crewai.command()
+@click.argument("project_name")
+def create(project_name):
+    """Create a new crew."""
+    create_crew(project_name)
+
+
+if __name__ == "__main__":
+    crewai()

src/crewai/cli/create_crew.py

@@ -0,0 +1,80 @@
+import os
+from pathlib import Path
+
+import click
+
+
+def create_crew(name):
+    """Create a new crew."""
+    folder_name = name.replace(" ", "_").replace("-", "_").lower()
+    class_name = name.replace("_", " ").replace("-", " ").title().replace(" ", "")
+
+    click.secho(f"Creating folder {folder_name}...", fg="green", bold=True)
+
+    if not os.path.exists(folder_name):
+        os.mkdir(folder_name)
+        os.mkdir(folder_name + "/tests")
+        os.mkdir(folder_name + "/src")
+        os.mkdir(folder_name + f"/src/{folder_name}")
+        os.mkdir(folder_name + f"/src/{folder_name}/tools")
+        os.mkdir(folder_name + f"/src/{folder_name}/config")
+        with open(folder_name + "/.env", "w") as file:
+            file.write("OPENAI_API_KEY=YOUR_API_KEY")
+    else:
+        click.secho(
+            f"\tFolder {folder_name} already exists. Please choose a different name.",
+            fg="red",
+        )
+        return
+
+    package_dir = Path(__file__).parent
+    templates_dir = package_dir / "templates"
+
+    # List of template files to copy
+    root_template_files = [
+        ".gitignore",
+        "pyproject.toml",
+        "README.md",
+    ]
+    tools_template_files = ["tools/custom_tool.py", "tools/__init__.py"]
+    config_template_files = ["config/agents.yaml", "config/tasks.yaml"]
+    src_template_files = ["__init__.py", "main.py", "crew.py"]
+
+    for file_name in root_template_files:
+        src_file = templates_dir / file_name
+        dst_file = Path(folder_name) / file_name
+        copy_template(src_file, dst_file, name, class_name, folder_name)
+
+    for file_name in src_template_files:
+        src_file = templates_dir / file_name
+        dst_file = Path(folder_name) / "src" / folder_name / file_name
+        copy_template(src_file, dst_file, name, class_name, folder_name)
+
+    for file_name in tools_template_files:
+        src_file = templates_dir / file_name
+        dst_file = Path(folder_name) / "src" / folder_name / file_name
+        copy_template(src_file, dst_file, name, class_name, folder_name)
+
+    for file_name in config_template_files:
+        src_file = templates_dir / file_name
+        dst_file = Path(folder_name) / "src" / folder_name / file_name
+        copy_template(src_file, dst_file, name, class_name, folder_name)
+
+    click.secho(f"Crew {name} created successfully!", fg="green", bold=True)
+
+
+def copy_template(src, dst, name, class_name, folder_name):
+    """Copy a file from src to dst."""
+    with open(src, "r") as file:
+        content = file.read()
+
+    # Interpolate the content
+    content = content.replace("{{name}}", name)
+    content = content.replace("{{crew_name}}", class_name)
+    content = content.replace("{{folder_name}}", folder_name)
+
+    # Write the interpolated content to the new file
+    with open(dst, "w") as file:
+        file.write(content)
+
+    click.secho(f"  - Created {dst}", fg="green")

src/crewai/cli/templates/.gitignore

@@ -0,0 +1,2 @@
+.env
+__pycache__/

src/crewai/cli/templates/README.md

@@ -0,0 +1,54 @@
+# {{crew_name}} Crew
+
+Welcome to the {{crew_name}} 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
+
+- 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 crew of AI agents and begin task execution, run this from the root folder of your project:
+
+```bash
+poetry run {{folder_name}}
+```
+
+This command initializes the {{name}} Crew, assembling the agents and assigning them tasks as defined in your configuration.
+
+## 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](https://docs.crewai.com)
+- Reach out to us through our [GitHub repository](https://github.com/joaomdmoura/crewai)
+- [Joing our Discord](https://discord.com/invite/X4JWnZnxPb)
+- [Chat wtih our docs](https://chatg.pt/DWjSBZn)
+
+Let's create wonders together with the power and simplicity of crewAI.

src/crewai/cli/templates/config/agents.yaml

@@ -0,0 +1,19 @@
+researcher:
+  role: >
+    {topic} Senior Data Researcher
+  goal: >
+    Uncover cutting-edge developments in {topic}
+  backstory: >
+    You're a seasoned researcher with a knack for uncovering the latest
+    developments in {topic}. Known for your ability to find the most relevant
+    information and present it in a clear and concise manner.
+
+reporting_analyst:
+  role: >
+    {topic} Reporting Analyst
+  goal: >
+    Create detailed reports based on {topic} data analysis and research findings
+  backstory: >
+    You're a meticulous analyst with a keen eye for detail. You're known for
+    your ability to turn complex data into clear and concise reports, making
+    it easy for others to understand and act on the information you provide.

src/crewai/cli/templates/config/tasks.yaml

@@ -0,0 +1,15 @@
+research_task:
+  description: >
+    Conduct a thorough research about {topic}
+    Make sure you find any interesting and relevant information given
+    the current year is 2024.
+  expected_output: >
+    A list with 10 bullet points of the most relevant information about {topic}
+
+reporting_task:
+  description: >
+    Review the context you got and expand each topic into a full section for a report.
+    Make sure the report is detailed and contains any and all relevant information.
+  expected_output: >
+    A fully fledge reports with the mains topics, each with a full section of information.
+    Formated as markdown with out '```'

src/crewai/cli/templates/crew.py

@@ -0,0 +1,54 @@
+from crewai import Agent, Crew, Process, Task
+from crewai.project import CrewBase, agent, crew, task
+
+from .tools.custom_tool import MyCustomTool
+
+# Check our tools documentations for more information on how to use them
+# from crewai_tools import SerperDevTool
+
+@CrewBase
+class {{crew_name}}Crew():
+	"""{{crew_name}} crew"""
+	agents_config = 'config/agents.yaml'
+	tasks_config = 'config/tasks.yaml'
+
+	@agent
+	def researcher(self) -> Agent:
+		return Agent(
+			config=self.agents_config['researcher'],
+			# tools=[MyCustomTool()], # Example of custom tool
+			verbose=True
+		)
+
+	@agent
+	def reporting_analyst(self) -> Agent:
+		return Agent(
+			config=self.agents_config['reporting_analyst'],
+			verbose=True
+		)
+
+	@task
+	def research_task(self) -> Task:
+		return Task(
+			config=self.tasks_config['research_task'],
+			agent=self.researcher()
+		)
+
+	@task
+	def research_task(self) -> Task:
+		return Task(
+			config=self.tasks_config['reporting_task'],
+			agent=self.reporting_analyst(),
+			output_file='report.md'
+		)
+
+	@crew
+	def crew(self) -> Crew:
+		"""Creates the {{crew_name}} crew"""
+		return Crew(
+			agents=self.agents, # Automatically created by the @agent decorator
+			tasks=self.tasks, # Automatically created by the @task decorator
+			process=Process.sequential,
+			verbose=2,
+			# process=Process.hierarchical, # In case you wanna use that instead https://docs.crewai.com/how-to/Hierarchical/
+		)

src/crewai/cli/templates/main.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python
+from .crew import {{crew_name}}Crew
+
+
+def run():
+    # Replace with your inputs, it will automatically interpolate any tasks and agents information
+    inputs = {'topic': 'AI LLMs'}
+    {{crew_name}}Crew().crew().kickoff(inputs=inputs)

src/crewai/cli/templates/pyproject.toml

@@ -0,0 +1,16 @@
+[tool.poetry]
+name = "{{folder_name}}"
+version = "0.1.0"
+description = "{{name}} using crewAI"
+authors = ["Your Name <you@example.com>"]
+
+[tool.poetry.dependencies]
+python = ">=3.10,<=3.13"
+crewai = {extras = ["tools"], version = "^0.20.0"}
+
+[tool.poetry.scripts]
+{{folder_name}} = "{{folder_name}}.main:run"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

src/crewai/cli/templates/tools/custom_tool.py

@@ -0,0 +1,13 @@
+# For this make sure to install the tools package
+# pip install 'crewai[tools]'
+
+from crewai_tools import BaseTool
+
+
+class MyCustomTool(BaseTool):
+    name: str = "Name of my tool"
+    description: str = "Clear description for what this tool is useful for, you agent will need this information to use it."
+
+    def _run(self, argument: str) -> str:
+        # Implementation goes here
+        return "this is an example of a tool output, ignore it and move along."

src/crewai/project/__init__.py

@@ -0,0 +1,2 @@
+from .annotations import agent, crew, task
+from .crew_base import CrewBase

src/crewai/project/annotations.py

@@ -0,0 +1,44 @@
+def task(func):
+    func.is_task = True
+    return func
+
+
+def agent(func):
+    func.is_agent = True
+    return func
+
+
+def crew(func):
+    def wrapper(self, *args, **kwargs):
+        instantiated_tasks = []
+        instantiated_agents = []
+
+        # Instantiate tasks and collect their associated agents
+        agent_roles = set()
+        for attr_name in dir(self):
+            possible_task = getattr(self, attr_name)
+            if callable(possible_task) and hasattr(possible_task, "is_task"):
+                task_instance = possible_task()
+                instantiated_tasks.append(task_instance)
+                if hasattr(task_instance, "agent"):
+                    agent_instance = task_instance.agent
+                    if agent_instance.role not in agent_roles:
+                        instantiated_agents.append(agent_instance)
+                        agent_roles.add(agent_instance.role)
+
+        # Instantiate any additional agents not already included by tasks
+        for attr_name in dir(self):
+            possible_agent = getattr(self, attr_name)
+            if callable(possible_agent) and hasattr(possible_agent, "is_agent"):
+                temp_agent_instance = possible_agent()
+                if temp_agent_instance.role not in agent_roles:
+                    instantiated_agents.append(temp_agent_instance)
+                    agent_roles.add(temp_agent_instance.role)
+
+        self.agents = instantiated_agents
+        self.tasks = instantiated_tasks
+
+        # Now call the original crew method
+        return func(self, *args, **kwargs)
+
+    return wrapper

src/crewai/project/crew_base.py

@@ -0,0 +1,42 @@
+import inspect
+import os
+from pathlib import Path
+
+import yaml
+
+
+def CrewBase(cls):
+    class WrappedClass(cls):
+        is_crew_class = True
+
+        base_directory = None
+        for frame_info in inspect.stack():
+            if "site-packages" not in frame_info.filename:
+                base_directory = Path(frame_info.filename).parent.resolve()
+                break
+
+        if base_directory is None:
+            raise Exception(
+                "Unable to dynamically determine the project's base directory, you must run it from the project's root directory."
+            )
+
+        original_agents_config_path = getattr(
+            cls, "agents_config", "config/agents.yaml"
+        )
+        original_tasks_config_path = getattr(cls, "tasks_config", "config/tasks.yaml")
+
+        def __init__(self, *args, **kwargs):
+            super().__init__(*args, **kwargs)
+            self.agents_config = self.load_yaml(
+                os.path.join(self.base_directory, self.original_agents_config_path)
+            )
+            self.tasks_config = self.load_yaml(
+                os.path.join(self.base_directory, self.original_tasks_config_path)
+            )
+
+        @staticmethod
+        def load_yaml(config_path: str):
+            with open(config_path, "r") as file:
+                return yaml.safe_load(file)
+
+    return WrappedClass

src/crewai/translations/en.json

@@ -25,7 +25,7 @@
     "tool_usage_error": "I encountered an error: {error}",
     "tool_arguments_error": "Error: the Action Input is not a valid key, value dictionary.",
     "wrong_tool_name": "You tried to use the tool {tool}, but it doesn't exist. You must use one of the following tools, use one at time: {tools}.",
-    "tool_usage_exception": "I encountered an error while trying to use the tool. This was the error: {error}.\n Tool {tool} accepts there inputs: {tool_inputs}"
+    "tool_usage_exception": "I encountered an error while trying to use the tool. This was the error: {error}.\n Tool {tool} accepts these inputs: {tool_inputs}"
   },
   "tools": {
     "delegate_work": "Delegate a specific task to one of the following co-workers: {coworkers}\nThe input to this tool should be the coworker, the task you want them to do, and ALL necessary context to exectue the task, they know nothing about the task, so share absolute everything you know, don't reference things but instead explain them.",

src/crewai/utilities/converter.py

@@ -78,8 +78,8 @@ class Converter(BaseModel):
         )
 
         parser = CrewPydanticOutputParser(pydantic_object=self.model)
-        new_prompt = HumanMessage(content=self.text) + SystemMessage(
-            content=self.instructions
+        new_prompt = SystemMessage(content=self.instructions) + HumanMessage(
+            content=self.text
         )
         return new_prompt | self.llm | parser
 

src/crewai/utilities/logger.py

@@ -1,4 +1,9 @@
+from crewai.utilities.printer import Printer
+
+
 class Logger:
+    _printer = Printer()
+
     def __init__(self, verbose_level=0):
         verbose_level = (
             2 if isinstance(verbose_level, bool) and verbose_level else verbose_level
@@ -8,4 +13,4 @@ class Logger:
     def log(self, level, message):
         level_map = {"debug": 1, "info": 2}
         if self.verbose_level and level_map.get(level, 0) <= self.verbose_level:
-            print(f"[{level.upper()}]: {message}")
+            self._printer.print(f"[{level.upper()}]: {message}", color="bold_green")

src/crewai/utilities/printer.py

@@ -4,9 +4,14 @@ class Printer:
             self._print_yellow(content)
         elif color == "red":
             self._print_red(content)
+        elif color == "bold_green":
+            self._print_bold_green(content)
         else:
             print(content)
 
+    def _print_bold_green(self, content):
+        print("\033[1m\033[92m {}\033[00m".format(content))
+
     def _print_yellow(self, content):
         print("\033[93m {}\033[00m".format(content))
 

tests/agent_test.py

@@ -663,3 +663,20 @@ def test_agent_llm_uses_token_calc_handler_with_llm_has_model_name():
     assert (
         agent1.llm.callbacks[0].token_cost_process.__class__.__name__ == "TokenProcess"
     )
+
+
+def test_agent_definition_based_on_dict():
+    config = {
+        "role": "test role",
+        "goal": "test goal",
+        "backstory": "test backstory",
+        "verbose": True,
+    }
+
+    agent = Agent(config=config)
+
+    assert agent.role == "test role"
+    assert agent.goal == "test goal"
+    assert agent.backstory == "test backstory"
+    assert agent.verbose == True
+    assert agent.tools == []

tests/task_test.py

@@ -449,3 +449,16 @@ def test_increment_tool_errors():
         increment_tools_errors.return_value = None
         crew.kickoff()
         increment_tools_errors.assert_called_once
+
+
+def test_task_definition_based_on_dict():
+    config = {
+        "description": "Give me an integer score between 1-5 for the following title: 'The impact of AI in the future of work', check examples to based your evaluation.",
+        "expected_output": "The score of the title.",
+    }
+
+    task = Task(config=config)
+
+    assert task.description == config["description"]
+    assert task.expected_output == config["expected_output"]
+    assert task.agent is None