WIP: v1 docs (#3626)

(cherry picked from commit d46e20fa09bcd2f5916282f5553ddeb7183bd92c)
This commit is contained in:
Tony Kipkemboi
2025-10-01 10:25:28 -04:00
committed by GitHub
parent 0fe9352149
commit c793c829ea
96 changed files with 4291 additions and 710 deletions

View File

@@ -1,96 +1,107 @@
---
title: "CrewAI Documentation"
description: "Build collaborative AI agents, crews, and flows — fast."
mode: "center"
description: "Build collaborative AI agents, crews, and flows — production ready from day one."
icon: "house"
mode: "wide"
---
<div style={{
display: 'flex',
flexDirection: 'column',
alignItems: 'center',
gap: 16,
textAlign: 'center',
padding: '48px 0',
background: 'linear-gradient(180deg, rgba(235,102,88,0.10) 0%, rgba(201,76,60,0.10) 100%)',
border: '1px solid rgba(235,102,88,0.25)',
borderRadius: 12
}}>
<img src="/images/crew_only_logo.png" alt="CrewAI" width="96" height="96" />
<p style={{ marginTop: 8, maxWidth: 820, color: 'var(--mint-text-2)' }}>
Orchestrate multiagent systems and flows with guardrails, memory, knowledge, tools, and observability. Productionready by default.
</p>
import { SearchBar } from "@mintlify/components";
<div style={{ display: 'flex', flexWrap: 'wrap', gap: 12, justifyContent: 'center', marginTop: 16 }}>
<div
style={{
display: 'flex',
flexDirection: 'column',
alignItems: 'center',
gap: 20,
textAlign: 'center',
padding: '48px 24px',
borderRadius: 16,
background: 'linear-gradient(180deg, rgba(235,102,88,0.12) 0%, rgba(201,76,60,0.08) 100%)',
border: '1px solid rgba(235,102,88,0.18)'
}}
>
<img src="/images/crew_only_logo.png" alt="CrewAI" width="250" height="100" />
<div style={{ maxWidth: 720 }}>
<h1 style={{ marginBottom: 12 }}>Ship multiagent systems with confidence</h1>
<p style={{ color: 'var(--mint-text-2)' }}>
Design agents, orchestrate crews, and automate flows with guardrails, memory, knowledge, and observability baked in.
</p>
</div>
<div style={{ display: 'flex', flexWrap: 'wrap', gap: 12, justifyContent: 'center' }}>
<a className="button button-primary" href="/en/quickstart">Get started</a>
<a className="button" href="/en/installation">Installation</a>
<a className="button" href="/en/concepts/flows">Flows</a>
<a className="button" href="/en/concepts/agents">Agents</a>
<a className="button" href="/en/tools/overview">Tools</a>
<a className="button" href="/en/changelog">View changelog</a>
<a className="button" href="/en/api-reference/introduction">API Reference</a>
</div>
</div>
<div style={{ marginTop: 32 }} />
## Get started
<CardGroup cols={3}>
<Card title="Quickstart" href="/en/quickstart" icon="rocket">
Create your first crew in minutes. Learn the core runtime, project layout, and dev loop.
<Card title="Introduction" href="/en/introduction" icon="sparkles">
Overview of CrewAI concepts, architecture, and what you can build with agents, crews, and flows.
</Card>
<Card title="Installation" href="/en/installation" icon="wrench">
Install via UV and set up environment keys for OpenAI and tools.
Install via `uv`, configure API keys, and set up the CLI for local development.
</Card>
<Card title="CLI" href="/en/concepts/cli" icon="terminal">
Create, run, train, test, deploy, and manage configs — all from the CLI.
<Card title="Quickstart" href="/en/quickstart" icon="rocket">
Spin up your first crew in minutes. Learn the core runtime, project layout, and dev loop.
</Card>
</CardGroup>
## Build the basics
<CardGroup cols={3}>
<Card title="Agents" href="/en/concepts/agents" icon="users">
Compose robust agents with memory, knowledge, and tools. Structure outputs with Pydantic.
Compose agents with tools, memory, knowledge, and structured outputs using Pydantic. Includes templates and best practices.
</Card>
<Card title="Flows" href="/en/concepts/flows" icon="arrow-progress">
Design complex workflows with start/listen/router, state, persistence, and resumability.
Orchestrate start/listen/router steps, manage state, persist execution, and resume long-running workflows.
</Card>
<Card title="Memory & Knowledge" href="/en/concepts/memory" icon="database">
Shortterm, longterm, and entity memory. Builtin knowledge with vector storage.
<Card title="Tasks & Processes" href="/en/concepts/tasks" icon="check">
Define sequential, hierarchical, or hybrid processes with guardrails, callbacks, and human-in-the-loop triggers.
</Card>
</CardGroup>
## Enterprise journey
<CardGroup cols={3}>
<Card title="RAG & Vector Stores" href="/en/concepts/knowledge#vector-store-rag-client-configuration" icon="stack">
Providerneutral client. ChromaDB by default, Qdrant supported. Configure per use case.
<Card title="Deploy automations" href="/en/enterprise/features/automations" icon="server">
Manage environments, redeploy safely, and monitor live runs directly from the Enterprise console.
</Card>
<Card title="Observability" href="/en/observability/overview" icon="timeline">
Traces with batching, metrics, and integrations (Langfuse, Phoenix, and more).
<Card title="Triggers & Flows" href="/en/enterprise/guides/automation-triggers" icon="bolt">
Connect Gmail, Slack, Salesforce, and more. Pass trigger payloads into crews and flows automatically.
</Card>
<Card title="Enterprise" href="/en/enterprise/introduction" icon="building">
Deploy, automate with triggers, manage orgs, and run at scale.
<Card title="Team management" href="/en/enterprise/guides/team-management" icon="users-gear">
Invite teammates, configure RBAC, and control access to production automations.
</Card>
</CardGroup>
<Frame>
<img src="/images/asset.png" alt="CrewAI — multiagent orchestration" />
<figcaption>Compose agents, tasks, flows, and tools — productionready by default.</figcaption>
</Frame>
## Whats new
## Popular paths
<CardGroup cols={2}>
<Card title="Triggers overview" href="/en/enterprise/guides/automation-triggers" icon="sparkles">
Unified overview for Gmail, Drive, Outlook, Teams, OneDrive, HubSpot, and more — now with sample payloads and crews.
</Card>
<Card title="Integration tools" href="/en/tools/integration/overview" icon="plug">
Call existing CrewAI automations or Amazon Bedrock Agents directly from your crews using the updated integration toolkit.
</Card>
</CardGroup>
- Getting started: [/en/quickstart](/en/quickstart)
- Install + requirements: [/en/installation](/en/installation)
- Define crews via YAML: [/en/guides/crews/first-crew](/en/guides/crews/first-crew)
- Build flows: [/en/guides/flows/first-flow](/en/guides/flows/first-flow)
- API Reference: [/en/api-reference/introduction](/en/api-reference/introduction)
<Callout title="Explore real-world patterns" icon="github">
Browse the <a href="/en/examples/cookbooks">examples and cookbooks</a> for end-to-end reference implementations across agents, flows, and enterprise automations.
</Callout>
<Note>
Looking for examples? Check out the examples repo and cookbooks under <a href="/en/examples/cookbooks">/en/examples/cookbooks</a>.
</Note>
## Stay connected
<CardGroup cols={2}>
<Card title="Star us on GitHub" href="https://github.com/crewAIInc/crewAI" icon="star">
If CrewAI helps you ship faster, give us a star and join the community.
If CrewAI helps you ship faster, give us a star and share your builds with the community.
</Card>
<Card title="Join the community" href="https://community.crewai.com" icon="comments">
Ask questions, share feedback, and see what others are building.
Ask questions, showcase workflows, and request features alongside other builders.
</Card>
</CardGroup>