mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-04 22:49:23 +00:00
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
163 lines
5.5 KiB
Plaintext
163 lines
5.5 KiB
Plaintext
---
|
|
title: Build Your First Crew
|
|
description: Step-by-step tutorial to create a collaborative AI team with JSON-first crew configuration.
|
|
icon: users-gear
|
|
mode: "wide"
|
|
---
|
|
|
|
## Build a Research Crew
|
|
|
|
In this guide, you will create a two-agent research crew that gathers information about a topic and writes a markdown report. New crew projects are JSON-first: agents are defined in `agents/*.jsonc`, tasks and crew settings are defined in `crew.jsonc`, and `crewai run` loads the JSON definition directly.
|
|
|
|
### Prerequisites
|
|
|
|
Before starting, make sure you have:
|
|
|
|
1. Installed CrewAI following the [installation guide](/en/installation)
|
|
2. Set up your LLM API key following the [LLM setup guide](/en/concepts/llms#setting-up-your-llm)
|
|
3. A [Serper.dev](https://serper.dev/) API key if you want the researcher to use web search
|
|
|
|
## Step 1: Create a New Crew
|
|
|
|
```bash
|
|
crewai create crew research_crew
|
|
cd research_crew
|
|
```
|
|
|
|
The CLI creates a JSON-first project:
|
|
|
|
```text
|
|
research_crew/
|
|
├── .gitignore
|
|
├── .env
|
|
├── agents/
|
|
│ └── researcher.jsonc
|
|
├── crew.jsonc
|
|
├── knowledge/
|
|
├── pyproject.toml
|
|
├── README.md
|
|
├── skills/
|
|
└── tools/
|
|
```
|
|
|
|
<Tip>
|
|
Need the older `crew.py`, `config/agents.yaml`, and `config/tasks.yaml` layout? Create it with `crewai create crew research_crew --classic`.
|
|
</Tip>
|
|
|
|
## Step 2: Define Your Agents
|
|
|
|
Replace the generated `agents/researcher.jsonc` file and add `agents/analyst.jsonc`. The file names are the names you reference from `crew.jsonc`.
|
|
|
|
```jsonc agents/researcher.jsonc
|
|
{
|
|
"role": "Senior Research Specialist for {topic}",
|
|
"goal": "Find comprehensive and accurate information about {topic}, with a focus on recent developments and key insights.",
|
|
"backstory": "You are an experienced research specialist who organizes complex information into clear, useful notes.",
|
|
// Replace with your model, for example "openai/gpt-4o".
|
|
"llm": "provider/model-id",
|
|
"tools": ["SerperDevTool"],
|
|
"settings": {
|
|
"verbose": true,
|
|
"allow_delegation": false
|
|
}
|
|
}
|
|
```
|
|
|
|
```jsonc agents/analyst.jsonc
|
|
{
|
|
"role": "Report Analyst for {topic}",
|
|
"goal": "Turn research findings into a clear, well-structured report.",
|
|
"backstory": "You are a careful analyst with strong technical writing skills and a talent for extracting useful insights.",
|
|
// Replace with your model, for example "openai/gpt-4o".
|
|
"llm": "provider/model-id",
|
|
"settings": {
|
|
"verbose": true,
|
|
"allow_delegation": false
|
|
}
|
|
}
|
|
```
|
|
|
|
Replace `provider/model-id` with the model you use, for example `openai/gpt-4o`, `anthropic/claude-sonnet-4-6`, or `gemini/gemini-2.0-flash-001`.
|
|
|
|
## Step 3: Define Tasks and Crew Settings
|
|
|
|
Replace `crew.jsonc` with:
|
|
|
|
```jsonc crew.jsonc
|
|
{
|
|
"name": "Research Crew",
|
|
"agents": ["researcher", "analyst"],
|
|
"tasks": [
|
|
{
|
|
"name": "research_task",
|
|
"description": "Conduct thorough research on {topic}. Focus on key concepts, recent developments, major challenges, notable applications, and future outlook.",
|
|
"expected_output": "A comprehensive research document with organized sections, specific facts, and useful examples about {topic}.",
|
|
"agent": "researcher"
|
|
},
|
|
{
|
|
"name": "analysis_task",
|
|
"description": "Analyze the research findings and create a polished report on {topic}. Include an executive summary, key insights, trend analysis, and recommendations.",
|
|
"expected_output": "A professional markdown report with clear headings, a concise summary, main findings, and recommendations.",
|
|
"agent": "analyst",
|
|
"context": ["research_task"],
|
|
"output_file": "output/report.md",
|
|
"markdown": true
|
|
}
|
|
],
|
|
"process": "sequential",
|
|
"verbose": true,
|
|
"memory": true,
|
|
"inputs": {
|
|
"topic": "Artificial Intelligence in Healthcare"
|
|
}
|
|
}
|
|
```
|
|
|
|
`context` points to prior task names, so the analyst receives the research task output. The `inputs` object provides default values for `{topic}`. If you remove a default, `crewai run` prompts for it.
|
|
|
|
## Step 4: Set Environment Variables
|
|
|
|
Open `.env` and add the keys your model and tools need:
|
|
|
|
```sh
|
|
SERPER_API_KEY=your_serper_api_key
|
|
# Add your model provider API key here too.
|
|
```
|
|
|
|
See the [LLM setup guide](/en/concepts/llms#setting-up-your-llm) for provider-specific keys.
|
|
|
|
## Step 5: Install and Run
|
|
|
|
```bash
|
|
crewai install
|
|
crewai run
|
|
```
|
|
|
|
`crewai run` detects `crew.jsonc`, loads the agents from `agents/`, prompts for missing placeholders, and runs the crew. When the run finishes, open `output/report.md`.
|
|
|
|
## How It Works
|
|
|
|
1. `crew.jsonc` defines the crew, task order, process, memory, and runtime inputs.
|
|
2. `agents/researcher.jsonc` and `agents/analyst.jsonc` define the agents.
|
|
3. The researcher runs first.
|
|
4. The analyst runs second with `context: ["research_task"]`.
|
|
5. The final task writes `output/report.md`.
|
|
|
|
## Extending Your Crew
|
|
|
|
You can add:
|
|
|
|
- More agents by creating new `agents/<name>.jsonc` files and listing them in `crew.jsonc`
|
|
- More tasks by appending objects to the `tasks` array
|
|
- Built-in tools by adding tool class names such as `"FileReadTool"` or `"SerperDevTool"`
|
|
- Custom tools with `"custom:<name>"`, which loads `tools/<name>.py`
|
|
- Hierarchical execution with `"process": "hierarchical"` and a `manager_llm` or `manager_agent`
|
|
|
|
<Warning>
|
|
Only run JSON crew projects from sources you trust. `custom:<name>` tools and `{"python": "module.attribute"}` references execute local Python code when the crew loads.
|
|
</Warning>
|
|
|
|
<Check>
|
|
You now have a working JSON-first crew that researches a topic and writes a report.
|
|
</Check>
|