Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.
adding new docs
João Moura918c0589eb0c
diff --git a/docs/concepts/agents.mdx b/docs/concepts/agents.mdxindex b81099386..8f04b9d49 100644--- a/docs/concepts/agents.mdx+++ b/docs/concepts/agents.mdx@@ -18,6 +18,18 @@ In the CrewAI framework, an `Agent` is an autonomous unit that can:Think of an agent as a specialized team member with specific skills, expertise, and responsibilities. For example, a `Researcher` agent might excel at gathering and analyzing information, while a `Writer` agent might be better at creating content.</Tip>+<Note type="info" title="Enterprise Enhancement: Visual Agent Builder">+CrewAI Enterprise includes a Visual Agent Builder that simplifies agent creation and configuration without writing code. Design your agents visually and test them in real-time.++++The Visual Agent Builder enables:+- Intuitive agent configuration with form-based interfaces+- Real-time testing and validation+- Template library with pre-configured agent types+- Easy customization of agent attributes and behaviors+</Note>+## Agent Attributes| Attribute | Parameter | Type | Description |@@ -233,7 +245,7 @@ custom_agent = Agent(#### Code Execution- `allow_code_execution`: Must be True to run code-- `code_execution_mode`:+- `code_execution_mode`:- `"safe"`: Uses Docker (recommended for production)- `"unsafe"`: Direct execution (use only in trusted environments)diff --git a/docs/concepts/event-listener.mdx b/docs/concepts/event-listener.mdxindex d641687f0..95726e23a 100644--- a/docs/concepts/event-listener.mdx+++ b/docs/concepts/event-listener.mdx@@ -18,6 +18,20 @@ CrewAI uses an event bus architecture to emit events throughout the execution liWhen specific actions occur in CrewAI (like a Crew starting execution, an Agent completing a task, or a tool being used), the system emits corresponding events. You can register handlers for these events to execute custom code when they occur.+<Note type="info" title="Enterprise Enhancement: Prompt Tracing">+CrewAI Enterprise provides a built-in Prompt Tracing feature that leverages the event system to track, store, and visualize all prompts, completions, and associated metadata. This provides powerful debugging capabilities and transparency into your agent operations.++++With Prompt Tracing you can:+- View the complete history of all prompts sent to your LLM+- Track token usage and costs+- Debug agent reasoning failures+- Share prompt sequences with your team+- Compare different prompt strategies+- Export traces for compliance and auditing+</Note>+## Creating a Custom Event ListenerTo create a custom event listener, you need to:@@ -40,17 +54,17 @@ from crewai.utilities.events.base_event_listener import BaseEventListenerclass MyCustomListener(BaseEventListener):def __init__(self):super().__init__()-+def setup_listeners(self, crewai_event_bus):@crewai_event_bus.on(CrewKickoffStartedEvent)def on_crew_started(source, event):print(f"Crew '{event.crew_name}' has started execution!")-+@crewai_event_bus.on(CrewKickoffCompletedEvent)def on_crew_completed(source, event):print(f"Crew '{event.crew_name}' has completed execution!")print(f"Output: {event.output}")-+@crewai_event_bus.on(AgentExecutionCompletedEvent)def on_agent_execution_completed(source, event):print(f"Agent '{event.agent.role}' completed task")@@ -83,7 +97,7 @@ my_listener = MyCustomListener()class MyCustomCrew:# Your crew implementation...-+def crew(self):return Crew(agents=[...],@@ -106,7 +120,7 @@ my_listener = MyCustomListener()class MyCustomFlow(Flow):# Your flow implementation...-+@start()def first_step(self):# ...@@ -324,9 +338,9 @@ with crewai_event_bus.scoped_handlers():@crewai_event_bus.on(CrewKickoffStartedEvent)def temp_handler(source, event):print("This handler only exists within this context")-+# Do something that emits events-+# Outside the context, the temporary handler is removed```diff --git a/docs/concepts/tasks.mdx b/docs/concepts/tasks.mdxindex 1cd403482..8a0ce74e0 100644--- a/docs/concepts/tasks.mdx+++ b/docs/concepts/tasks.mdx@@ -12,6 +12,18 @@ Tasks provide all necessary details for execution, such as a description, the agTasks within CrewAI can be collaborative, requiring multiple agents to work together. This is managed through the task properties and orchestrated by the Crew's process, enhancing teamwork and efficiency.+<Note type="info" title="Enterprise Enhancement: Visual Task Builder">+CrewAI Enterprise includes a Visual Task Builder in Crew Studio that simplifies complex task creation and chaining. Design your task flows visually and test them in real-time without writing code.++++The Visual Task Builder enables:+- Drag-and-drop task creation+- Visual task dependencies and flow+- Real-time testing and validation+- Easy sharing and collaboration+</Note>+### Task Execution FlowTasks can be executed in two ways:@@ -414,7 +426,7 @@ It's also important to note that the output of the final task of a crew becomes### Using `output_pydantic`The `output_pydantic` property allows you to define a Pydantic model that the task output should conform to. This ensures that the output is not only structured but also validated according to the Pydantic model.-Here’s an example demonstrating how to use output_pydantic:+Here's an example demonstrating how to use output_pydantic:```python Codeimport json@@ -495,7 +507,7 @@ In this example:### Using `output_json`The `output_json` property allows you to define the expected output in JSON format. This ensures that the task's output is a valid JSON structure that can be easily parsed and used in your application.-Here’s an example demonstrating how to use `output_json`:+Here's an example demonstrating how to use `output_json`:```python Codeimport jsondiff --git a/docs/concepts/tools.mdx b/docs/concepts/tools.mdxindex 6910735ab..32c77bc60 100644--- a/docs/concepts/tools.mdx+++ b/docs/concepts/tools.mdx@@ -15,6 +15,18 @@ A tool in CrewAI is a skill or function that agents can utilize to perform varioThis includes tools from the [CrewAI Toolkit](https://github.com/joaomdmoura/crewai-tools) and [LangChain Tools](https://python.langchain.com/docs/integrations/tools),enabling everything from simple searches to complex interactions and effective teamwork among agents.+<Note type="info" title="Enterprise Enhancement: Tools Repository">+CrewAI Enterprise provides a comprehensive Tools Repository with pre-built integrations for common business systems and APIs. Deploy agents with enterprise tools in minutes instead of days.++++The Enterprise Tools Repository includes:+- Pre-built connectors for popular enterprise systems+- Custom tool creation interface+- Version control and sharing capabilities+- Security and compliance features+</Note>+## Key Characteristics of Tools- **Utility**: Crafted for tasks such as web searching, data analysis, content generation, and agent collaboration.@@ -79,7 +91,7 @@ research = Task()write = Task(- description='Write an engaging blog post about the AI industry, based on the research analyst’s summary. Draw inspiration from the latest blog posts in the directory.',+ description='Write an engaging blog post about the AI industry, based on the research analyst's summary. Draw inspiration from the latest blog posts in the directory.',expected_output='A 4-paragraph blog post formatted in markdown with engaging, informative, and accessible content, avoiding complex jargon.',agent=writer,output_file='blog-posts/new_post.md' # The final blog post will be saved here@@ -141,7 +153,7 @@ Here is a list of the available tools and their descriptions:## Creating your own Tools<Tip>- Developers can craft `custom tools` tailored for their agent’s needs or+ Developers can craft `custom tools` tailored for their agent's needs orutilize pre-built options.</Tip>diff --git a/docs/installation.mdx b/docs/installation.mdxindex b3daee5e8..a1fba2d64 100644--- a/docs/installation.mdx+++ b/docs/installation.mdx@@ -6,12 +6,12 @@ icon: wrench<Note>**Python Version Requirements**-+CrewAI requires `Python >=3.10 and <3.13`. Here's how to check your version:```bashpython3 --version```-+If you need to update Python, visit [python.org/downloads](https://python.org/downloads)</Note>@@ -140,6 +140,27 @@ We recommend using the `YAML` template scaffolding for a structured approach to</Step></Steps>+## Enterprise Installation Options++<Note type="info">+For teams and organizations, CrewAI offers enterprise deployment options that eliminate setup complexity:++### CrewAI Enterprise (SaaS)+- Zero installation required - just sign up for free at [app.crewai.com](https://app.crewai.com)+- Automatic updates and maintenance+- Managed infrastructure and scaling+- Build Crews with no Code++### CrewAI Factory (Self-hosted)+- Containerized deployment for your infrastructure+- Supports any hyperscaler including on prem depployments+- Integration with your existing security systems++<Card title="Explore Enterprise Options" icon="building" href="https://crewai.com/enterprise">+ Learn about CrewAI's enterprise offerings and schedule a demo+</Card>+</Note>+## Next Steps<CardGroup cols={2}>diff --git a/docs/introduction.mdx b/docs/introduction.mdxindex 416ead45a..92df910ff 100644--- a/docs/introduction.mdx+++ b/docs/introduction.mdx@@ -15,6 +15,7 @@ CrewAI empowers developers with both high-level simplicity and precise low-levelWith over 100,000 developers certified through our community courses, CrewAI is rapidly becoming the standard for enterprise-ready AI automation.+## How Crews Work<Note>diff --git a/docs/quickstart.mdx b/docs/quickstart.mdxindex 1edccee0e..2cbc2df9a 100644--- a/docs/quickstart.mdx+++ b/docs/quickstart.mdx@@ -200,6 +200,22 @@ Follow the steps below to get Crewing! 🚣♂️```</CodeGroup></Step>++ <Step title="Enterprise Alternative: Create in Crew Studio">+ For CrewAI Enterprise users, you can create the same crew without writing code:++ 1. Log in to your CrewAI Enterprise account (create a free account at [app.crewai.com](https://app.crewai.com))+ 2. Open Crew Studio+ 3. Type what is the automation you're tryign to build+ 4. Create your tasks visually and connect them in sequence+ 5. Configure your inputs and click "Download Code" or "Deploy"++ ++ <Card title="Try CrewAI Enterprise" icon="rocket" href="https://app.crewai.com">+ Start your free account at CrewAI Enterprise+ </Card>+ </Step><Step title="View your final report">You should see the output in the console and the `report.md` file should be created in the root of your project with the final report.@@ -271,7 +287,7 @@ Follow the steps below to get Crewing! 🚣♂️</Steps><Check>-Congratulations!+Congratulations!You have successfully set up your crew project and are ready to start building your own agentic workflows!</Check>