update readme.md

* Update LLM-Connections.md

* Update LLM-Connections.md

---------

Co-authored-by: João Moura <joaomdmoura@gmail.com>

README.md

@@ -8,7 +8,7 @@
 
 <h3>
 
-[Homepage](https://www.crewai.com/) | [Documentation](https://docs.crewai.com/) | [Chat with Docs](https://chatg.pt/DWjSBZn) | [Examples](https://github.com/crewAIInc/crewAI-examples) | [Discord](https://discord.com/invite/X4JWnZnxPb)
+[Homepage](https://www.crewai.com/) | [Documentation](https://docs.crewai.com/) | [Chat with Docs](https://chatg.pt/DWjSBZn) | [Examples](https://github.com/crewAIInc/crewAI-examples) | [Discourse](https://community.crewai.com)
 
 </h3>
 
@@ -284,3 +284,39 @@ Users can opt-in to Further Telemetry, sharing the complete telemetry data by se
 ## License
 
 CrewAI is released under the MIT License.
+
+## Frequently Asked Questions (FAQ)
+
+### Q: What is CrewAI?
+A: CrewAI is a cutting-edge framework for orchestrating role-playing, autonomous AI agents. It enables agents to work together seamlessly, tackling complex tasks through collaborative intelligence.
+
+### Q: How do I install CrewAI?
+A: You can install CrewAI using pip:
+```shell
+pip install crewai
+```
+For additional tools, use:
+```shell
+pip install 'crewai[tools]'
+```
+
+### Q: Can I use CrewAI with local models?
+A: Yes, CrewAI supports various LLMs, including local models. You can configure your agents to use local models via tools like Ollama & LM Studio. Check the [LLM Connections documentation](https://docs.crewai.com/how-to/LLM-Connections/) for more details.
+
+### Q: What are the key features of CrewAI?
+A: Key features include role-based agent design, autonomous inter-agent delegation, flexible task management, process-driven execution, output saving as files, and compatibility with both open-source and proprietary models.
+
+### Q: How does CrewAI compare to other AI orchestration tools?
+A: CrewAI is designed with production in mind, offering flexibility similar to Autogen's conversational agents and structured processes like ChatDev, but with more adaptability for real-world applications.
+
+### Q: Is CrewAI open-source?
+A: Yes, CrewAI is open-source and welcomes contributions from the community.
+
+### Q: Does CrewAI collect any data?
+A: CrewAI uses anonymous telemetry to collect usage data for improvement purposes. No sensitive data (like prompts, task descriptions, or API calls) is collected. Users can opt-in to share more detailed data by setting `share_crew=True` on their Crews.
+
+### Q: Where can I find examples of CrewAI in action?
+A: You can find various real-life examples in the [crewAI-examples repository](https://github.com/crewAIInc/crewAI-examples), including trip planners, stock analysis tools, and more.
+
+### Q: How can I contribute to CrewAI?
+A: Contributions are welcome! You can fork the repository, create a new branch for your feature, add your improvement, and send a pull request. Check the Contribution section in the README for more details.

docs/core-concepts/Pipeline.md

@@ -32,8 +32,8 @@ Each input creates its own run, flowing through all stages of the pipeline. Mult
 
 ## Pipeline Attributes
 
-| Attribute  | Parameters | Description                                                                           |
-| :--------- | :--------- | :------------------------------------------------------------------------------------ |
+| Attribute  | Parameters | Description                                                                                     |
+| :--------- | :--------- | :---------------------------------------------------------------------------------------------- |
 | **Stages** | `stages`   | A list of crews, lists of crews, or routers representing the stages to be executed in sequence. |
 
 ## Creating a Pipeline
@@ -239,7 +239,7 @@ email_router = Router(
             pipeline=normal_pipeline
         )
     },
-    default=Pipeline(stages=[normal_pipeline])  # Default to just classification if no urgency score
+    default=Pipeline(stages=[normal_pipeline])  # Default to just normal if no urgency score
 )
 
 # Use the router in a main pipeline

docs/core-concepts/Tasks.md

@@ -131,6 +131,7 @@ research_agent = Agent(
   verbose=True
 )
 
+# to perform a semantic search for a specified query from a text's content across the internet
 search_tool = SerperDevTool()
 
 task = Task(
@@ -312,4 +313,4 @@ save_output_task = Task(
 
 ## Conclusion
 
-Tasks are the driving force behind the actions of agents in crewAI. By properly defining tasks and their outcomes, you set the stage for your AI agents to work effectively, either independently or as a collaborative unit. Equipping tasks with appropriate tools, understanding the execution process, and following robust validation practices are crucial for maximizing CrewAI's potential, ensuring agents are effectively prepared for their assignments and that tasks are executed as intended.
+Tasks are the driving force behind the actions of agents in crewAI. By properly defining tasks and their outcomes, you set the stage for your AI agents to work effectively, either independently or as a collaborative unit. Equipping tasks with appropriate tools, understanding the execution process, and following robust validation practices are crucial for maximizing CrewAI's potential, ensuring agents are effectively prepared for their assignments and that tasks are executed as intended.

docs/getting-started/Start-a-New-CrewAI-Project-Template-Method.md

@@ -17,40 +17,12 @@ Before we start, there are a couple of things to note:
 Before getting started with CrewAI, make sure that you have installed it via pip:
 
 ```shell
-$ pip install crewai crewai-tools
+$ pip install 'crewai[tools]'
 ```
 
-### Virtual Environments
-It is highly recommended that you use virtual environments to ensure that your CrewAI project is isolated from other projects and dependencies. Virtual environments provide a clean, separate workspace for each project, preventing conflicts between different versions of packages and libraries. This isolation is crucial for maintaining consistency and reproducibility in your development process. You have multiple options for setting up virtual environments depending on your operating system and Python version:
-
-1. Use venv (Python's built-in virtual environment tool):
-   venv is included with Python 3.3 and later, making it a convenient choice for many developers. It's lightweight and easy to use, perfect for simple project setups.
-
-   To set up virtual environments with venv, refer to the official [Python documentation](https://docs.python.org/3/tutorial/venv.html).
-
-2. Use Conda (A Python virtual environment manager):
-   Conda is an open-source package manager and environment management system for Python. It's widely used by data scientists, developers, and researchers to manage dependencies and environments in a reproducible way.
-
-   To set up virtual environments with Conda, refer to the official [Conda documentation](https://docs.conda.io/projects/conda/en/stable/user-guide/getting-started.html).
-
-3. Use Poetry (A Python package manager and dependency management tool):
-   Poetry is an open-source Python package manager that simplifies the installation of packages and their dependencies. Poetry offers a convenient way to manage virtual environments and dependencies.
-   Poetry is CrewAI's preferred tool for package / dependency management in CrewAI.
-
-### Code IDEs
-
-Most users of CrewAI use a Code Editor / Integrated Development Environment (IDE) for building their Crews. You can use any code IDE of your choice. See below for some popular options for Code Editors / Integrated Development Environments (IDE):
-
-- [Visual Studio Code](https://code.visualstudio.com/) - Most popular
-- [PyCharm](https://www.jetbrains.com/pycharm/)
-- [Cursor AI](https://cursor.com)
-
-Pick one that suits your style and needs.
-
 ## Creating a New Project
-In this example, we will be using Venv as our virtual environment manager.
+In this example, we will be using poetry as our virtual environment manager.
 
-To set up a virtual environment, run the following CLI command:
 To create a new CrewAI project, run the following CLI command:
 
 ```shell

docs/how-to/LLM-Connections.md

@@ -143,13 +143,12 @@ os.environ["OPENAI_MODEL_NAME"]='mistral-small'
 from langchain_community.chat_models.solar import SolarChat
 ```
 ```sh
-os.environ["SOLAR_API_BASE"]='https://api.upstage.ai/v1/solar'
-os.environ["SOLAR_API_KEY"]='your-solar-api-key'
-```
+os.environ[SOLAR_API_BASE]="https://api.upstage.ai/v1/solar"
+os.environ[SOLAR_API_KEY]="your-solar-api-key"
 
 # Free developer API key available here: https://console.upstage.ai/services/solar
 # Langchain Example: https://github.com/langchain-ai/langchain/pull/18556
-
+```
 
 ### Cohere
 ```python

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "crewai"
-version = "0.54.0"
+version = "0.55.2"
 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"
@@ -8,7 +8,7 @@ packages = [{ include = "crewai", from = "src" }]
 
 [tool.poetry.urls]
 Homepage = "https://crewai.com"
-Documentation = "https://github.com/joaomdmoura/CrewAI/wiki/Index"
+Documentation = "https://docs.crewai.com"
 Repository = "https://github.com/crewAIInc/crewAI"
 
 [tool.poetry.dependencies]
@@ -20,8 +20,8 @@ opentelemetry-api = "^1.22.0"
 opentelemetry-sdk = "^1.22.0"
 opentelemetry-exporter-otlp-proto-http = "^1.22.0"
 instructor = "1.3.3"
-regex = "^2023.12.25"
-crewai-tools = { version = "^0.8.3", optional = true }
+regex = "^2024.7.24"
+crewai-tools = { version = "^0.12.0", optional = true }
 click = "^8.1.7"
 python-dotenv = "^1.0.0"
 appdirs = "^1.4.4"
@@ -47,7 +47,7 @@ mkdocs-material = { extras = ["imaging"], version = "^9.5.7" }
 mkdocs-material-extensions = "^1.3.1"
 pillow = "^10.2.0"
 cairosvg = "^2.7.1"
-crewai-tools = "^0.8.3"
+crewai-tools = "^0.12.0"
 
 [tool.poetry.group.test.dependencies]
 pytest = "^8.0.0"

src/crewai/__init__.py

@@ -2,6 +2,7 @@ from crewai.agent import Agent
 from crewai.crew import Crew
 from crewai.pipeline import Pipeline
 from crewai.process import Process
+from crewai.routers import Router
 from crewai.task import Task
 
-__all__ = ["Agent", "Crew", "Process", "Task", "Pipeline"]
+__all__ = ["Agent", "Crew", "Process", "Task", "Pipeline", "Router"]

src/crewai/cli/authentication/constants.py

@@ -1,4 +1,4 @@
 ALGORITHMS = ["RS256"]
-AUTH0_DOMAIN = "dev-jzsr0j8zs0atl5ha.us.auth0.com"
-AUTH0_CLIENT_ID = "CZtyRHuVW80HbLSjk4ggXNzjg4KAt7Oe"
-AUTH0_AUDIENCE = "https://dev-jzsr0j8zs0atl5ha.us.auth0.com/api/v2/"
+AUTH0_DOMAIN = "crewai.us.auth0.com"
+AUTH0_CLIENT_ID = "DEVC5Fw6NlRoSzmDCcOhVq85EfLBjKa8"
+AUTH0_AUDIENCE = "https://crewai.us.auth0.com/api/v2/"

src/crewai/cli/cli.py

@@ -203,10 +203,11 @@ def deploy():
 
 
 @deploy.command(name="create")
-def deploy_create():
+@click.option("-y", "--yes", is_flag=True, help="Skip the confirmation prompt")
+def deploy_create(yes: bool):
     """Create a Crew deployment."""
     deploy_cmd = DeployCommand()
-    deploy_cmd.create_crew()
+    deploy_cmd.create_crew(yes)
 
 
 @deploy.command(name="list")

src/crewai/cli/deploy/api.py

@@ -18,7 +18,7 @@ class CrewAPI:
             "User-Agent": f"CrewAI-CLI/{get_crewai_version()}",
         }
         self.base_url = getenv(
-            "CREWAI_BASE_URL", "https://dev.crewai.com/crewai_plus/api/v1/crews"
+            "CREWAI_BASE_URL", "https://crewai.com/crewai_plus/api/v1/crews"
         )
 
     def _make_request(self, method: str, endpoint: str, **kwargs) -> requests.Response:

src/crewai/cli/deploy/main.py

@@ -28,9 +28,7 @@ class DeployCommand:
             self._telemetry.set_tracer()
             access_token = get_auth_token()
         except Exception:
-            self._deploy_signup_error_span = self._telemetry.deploy_signup_error_span(
-                self
-            )
+            self._deploy_signup_error_span = self._telemetry.deploy_signup_error_span()
             console.print(
                 "Please sign up/login to CrewAI+ before using the CLI.",
                 style="bold red",
@@ -40,7 +38,10 @@ class DeployCommand:
 
         self.project_name = get_project_name()
         if self.project_name is None:
-            console.print("No project name found. Please ensure your project has a valid pyproject.toml file.", style="bold red")
+            console.print(
+                "No project name found. Please ensure your project has a valid pyproject.toml file.",
+                style="bold red",
+            )
             raise SystemExit
 
         self.client = CrewAPI(api_key=access_token)
@@ -100,7 +101,7 @@ class DeployCommand:
         Args:
             uuid (Optional[str]): The UUID of the crew to deploy.
         """
-        self._start_deployment_span = self._telemetry.start_deployment_span(self, uuid)
+        self._start_deployment_span = self._telemetry.start_deployment_span(uuid)
         console.print("Starting deployment...", style="bold blue")
         if uuid:
             response = self.client.deploy_by_uuid(uuid)
@@ -116,12 +117,12 @@ class DeployCommand:
         else:
             self._handle_error(json_response)
 
-    def create_crew(self) -> None:
+    def create_crew(self, confirm: bool) -> None:
         """
         Create a new crew deployment.
         """
-        self._create_crew_deployment_span = self._telemetry.create_crew_deployment_span(
-            self
+        self._create_crew_deployment_span = (
+            self._telemetry.create_crew_deployment_span()
         )
         console.print("Creating deployment...", style="bold blue")
         env_vars = fetch_and_json_env_file()
@@ -129,10 +130,13 @@ class DeployCommand:
 
         if remote_repo_url is None:
             console.print("No remote repository URL found.", style="bold red")
-            console.print("Please ensure your project has a valid remote repository.", style="yellow")
+            console.print(
+                "Please ensure your project has a valid remote repository.",
+                style="yellow",
+            )
             return
 
-        self._confirm_input(env_vars, remote_repo_url)
+        self._confirm_input(env_vars, remote_repo_url, confirm)
         payload = self._create_payload(env_vars, remote_repo_url)
 
         response = self.client.create_crew(payload)
@@ -141,18 +145,22 @@ class DeployCommand:
         else:
             self._handle_error(response.json())
 
-    def _confirm_input(self, env_vars: Dict[str, str], remote_repo_url: str) -> None:
+    def _confirm_input(
+        self, env_vars: Dict[str, str], remote_repo_url: str, confirm: bool
+    ) -> None:
         """
         Confirm input parameters with the user.
 
         Args:
             env_vars (Dict[str, str]): Environment variables.
             remote_repo_url (str): Remote repository URL.
+            confirm (bool): Whether to confirm input.
         """
-        input(f"Press Enter to continue with the following Env vars: {env_vars}")
-        input(
-            f"Press Enter to continue with the following remote repository: {remote_repo_url}\n"
-        )
+        if not confirm:
+            input(f"Press Enter to continue with the following Env vars: {env_vars}")
+            input(
+                f"Press Enter to continue with the following remote repository: {remote_repo_url}\n"
+            )
 
     def _create_payload(
         self,
@@ -266,9 +274,7 @@ class DeployCommand:
             uuid (Optional[str]): The UUID of the crew to get logs for.
             log_type (str): The type of logs to retrieve (default: "deployment").
         """
-        self._get_crew_logs_span = self._telemetry.get_crew_logs_span(
-            self, uuid, log_type
-        )
+        self._get_crew_logs_span = self._telemetry.get_crew_logs_span(uuid, log_type)
         console.print(f"Fetching {log_type} logs...", style="bold blue")
 
         if uuid:
@@ -291,7 +297,7 @@ class DeployCommand:
         Args:
             uuid (Optional[str]): The UUID of the crew to remove.
         """
-        self._remove_crew_span = self._telemetry.remove_crew_span(self, uuid)
+        self._remove_crew_span = self._telemetry.remove_crew_span(uuid)
         console.print("Removing deployment...", style="bold blue")
 
         if uuid:

src/crewai/cli/templates/crew/pyproject.toml

@@ -6,7 +6,7 @@ authors = ["Your Name <you@example.com>"]
 
 [tool.poetry.dependencies]
 python = ">=3.10,<=3.13"
-crewai = { extras = ["tools"], version = ">=0.54.0,<1.0.0" }
+crewai = { extras = ["tools"], version = ">=0.55.2,<1.0.0" }
 
 
 [tool.poetry.scripts]

src/crewai/cli/templates/pipeline/pyproject.toml

@@ -6,7 +6,7 @@ authors = ["Your Name <you@example.com>"]
 
 [tool.poetry.dependencies]
 python = ">=3.10,<=3.13"
-crewai = { extras = ["tools"], version = ">=0.54.0,<1.0.0" }
+crewai = { extras = ["tools"], version = ">=0.55.2,<1.0.0" }
 asyncio = "*"
 
 [tool.poetry.scripts]

src/crewai/cli/templates/pipeline_router/pyproject.toml

@@ -6,7 +6,7 @@ authors = ["Your Name <you@example.com>"]
 
 [tool.poetry.dependencies]
 python = ">=3.10,<=3.13"
-crewai = { extras = ["tools"], version = ">=0.54.0,<1.0.0" }
+crewai = { extras = ["tools"], version = ">=0.55.2,<1.0.0" }
 
 
 [tool.poetry.scripts]