mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-01 13:18:10 +00:00
* feat: update pyproject.toml to specify wheel targets Added a new section to the pyproject.toml file to include only specific files in the wheel build, enhancing the packaging process. Updated tests to verify the inclusion of these targets. * feat: add memory save event handling to activity log Implemented event handlers for MemorySaveStartedEvent, MemorySaveCompletedEvent, and MemorySaveFailedEvent in the crew_run_tui module. This allows the application to log memory save operations, capturing their status and details in the activity log. Added corresponding tests to verify the correct logging behavior for successful and failed memory saves. * feat: enhance memory save event handling in activity log Added functionality to suppress nested memory save events and updated the handling of MemorySaveStartedEvent, MemorySaveCompletedEvent, and MemorySaveFailedEvent to improve logging accuracy. Introduced new tests to verify the correct behavior of memory save events, including scenarios for nested events and completion updates for timed-out entries. * Fix memory save activity log handling * Normalize alpha package versions * Update scaffolded crew dependency * feat: add button to copy setup instructions for CrewAI coding agents Introduced a button in the documentation that allows users to easily copy setup instructions for CrewAI coding agents. The instructions include installation steps, environment setup, and best practices for using the CrewAI CLI. This enhancement aims to streamline the onboarding process for new users. * Improve missing CrewAI install guidance * fix: address pr review feedback * fix: avoid mismatched memory save rows * fix: wait for queued memory save events * fix: avoid matching memory saves on missing ids * chore: normalize prerelease version to 1.14.8a1
160 lines
6.0 KiB
Plaintext
160 lines
6.0 KiB
Plaintext
---
|
||
title: "CrewAI Documentation"
|
||
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: 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 multi‑agent 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>
|
||
<button
|
||
type="button"
|
||
className="button"
|
||
onClick={async (event) => {
|
||
const prompt = `Set up this environment so I can build with CrewAI.
|
||
|
||
First install the official CrewAI coding-agent skills if this environment supports npx:
|
||
|
||
npx skills add crewaiinc/skills
|
||
|
||
If npx is missing or the current agent cannot load skills, do not fail the whole setup. Report the exact issue and continue using the CrewAI docs directly.
|
||
|
||
Use these CrewAI docs as source of truth before making assumptions:
|
||
- https://skills.crewai.com
|
||
- https://docs.crewai.com/llms.txt
|
||
- https://docs.crewai.com/en/installation
|
||
- https://docs.crewai.com/en/guides/coding-tools/build-with-ai
|
||
|
||
Setup steps:
|
||
1. Check python3 --version. CrewAI requires Python >=3.10 and <3.14.
|
||
2. Install uv if missing:
|
||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||
3. Source the uv environment if needed:
|
||
source "$HOME/.local/bin/env"
|
||
4. Install the CrewAI CLI:
|
||
uv tool install crewai
|
||
5. Verify the CLI:
|
||
crewai version
|
||
crewai create --help
|
||
6. Create a project:
|
||
CREWAI_DMN=true crewai create
|
||
7. After project creation, inspect the generated files before editing.
|
||
8. Run:
|
||
crewai install
|
||
crewai run
|
||
|
||
Do not hardcode API keys. Use .env.
|
||
Do not invent CLI flags. Validate with crewai --help or crewai create --help.
|
||
If a command fails, show the exact command and error, explain the likely cause, fix what you can safely fix, and retry once.`;
|
||
const button = event.currentTarget;
|
||
try {
|
||
await navigator.clipboard.writeText(prompt);
|
||
button.textContent = "Copied";
|
||
} catch {
|
||
button.textContent = "Copy failed";
|
||
} finally {
|
||
window.setTimeout(() => {
|
||
button.textContent = "Copy instructions for coding agents";
|
||
}, 1600);
|
||
}
|
||
}}
|
||
>
|
||
Copy instructions for coding agents
|
||
</button>
|
||
<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="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`, configure API keys, and set up the CLI for local development.
|
||
</Card>
|
||
<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 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">
|
||
Orchestrate start/listen/router steps, manage state, persist execution, and resume long-running workflows.
|
||
</Card>
|
||
<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="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="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="Team management" href="/en/enterprise/guides/team-management" icon="users-gear">
|
||
Invite teammates, configure RBAC, and control access to production automations.
|
||
</Card>
|
||
</CardGroup>
|
||
|
||
## What’s new
|
||
|
||
<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>
|
||
|
||
<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>
|
||
|
||
## 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 share your builds with the community.
|
||
</Card>
|
||
<Card title="Join the community" href="https://community.crewai.com" icon="comments">
|
||
Ask questions, showcase workflows, and request features alongside other builders.
|
||
</Card>
|
||
</CardGroup>
|