mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-04 06:29:22 +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>
141 lines
4.5 KiB
Plaintext
141 lines
4.5 KiB
Plaintext
---
|
|
title: 첫 번째 Crew 만들기
|
|
description: JSON-first crew 설정으로 협업 AI 팀을 만드는 단계별 튜토리얼입니다.
|
|
icon: users-gear
|
|
mode: "wide"
|
|
---
|
|
|
|
## 리서치 Crew 만들기
|
|
|
|
이 가이드에서는 두 에이전트가 주제를 조사하고 markdown 보고서를 작성하는 crew를 만듭니다. 새 crew 프로젝트는 JSON-first입니다. 에이전트는 `agents/*.jsonc`, 태스크와 crew 설정은 `crew.jsonc`에 두며, `crewai run`이 이 정의를 직접 로드합니다.
|
|
|
|
### 준비 사항
|
|
|
|
1. [설치 가이드](/ko/installation)에 따라 CrewAI 설치
|
|
2. [LLM 설정](/ko/concepts/llms#setting-up-your-llm)에 따라 모델 API 키 설정
|
|
3. 웹 검색을 사용할 경우 [Serper.dev](https://serper.dev/) API 키 준비
|
|
|
|
## 1단계: 새 Crew 만들기
|
|
|
|
```bash
|
|
crewai create crew research_crew
|
|
cd research_crew
|
|
```
|
|
|
|
생성되는 구조:
|
|
|
|
```text
|
|
research_crew/
|
|
├── .gitignore
|
|
├── .env
|
|
├── agents/
|
|
│ └── researcher.jsonc
|
|
├── crew.jsonc
|
|
├── knowledge/
|
|
├── pyproject.toml
|
|
├── README.md
|
|
├── skills/
|
|
└── tools/
|
|
```
|
|
|
|
<Tip>
|
|
`crew.py`, `config/agents.yaml`, `config/tasks.yaml`을 쓰는 기존 레이아웃이 필요하면 `crewai create crew research_crew --classic`을 사용하세요.
|
|
</Tip>
|
|
|
|
## 2단계: 에이전트 정의
|
|
|
|
생성된 `agents/researcher.jsonc` 파일을 교체하고 `agents/analyst.jsonc`를 추가합니다. 파일 이름이 `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.",
|
|
// 사용하는 모델로 바꾸세요. 예: "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.",
|
|
// 사용하는 모델로 바꾸세요. 예: "openai/gpt-4o".
|
|
"llm": "provider/model-id",
|
|
"settings": {
|
|
"verbose": true,
|
|
"allow_delegation": false
|
|
}
|
|
}
|
|
```
|
|
|
|
`provider/model-id`를 `openai/gpt-4o`, `anthropic/claude-sonnet-4-6`, `gemini/gemini-2.0-flash-001` 같은 모델로 바꾸세요.
|
|
|
|
## 3단계: 태스크와 Crew 설정
|
|
|
|
`crew.jsonc`를 다음으로 교체합니다:
|
|
|
|
```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`는 이전 태스크 이름을 가리키므로 analyst가 research 태스크 출력을 받습니다. `inputs`는 `{topic}`의 기본값을 제공합니다. 기본값이 없으면 `crewai run`이 실행 중에 물어봅니다.
|
|
|
|
## 4단계: 환경 변수 설정
|
|
|
|
`.env`를 편집합니다:
|
|
|
|
```sh
|
|
SERPER_API_KEY=your_serper_api_key
|
|
# 모델 제공자 API 키도 추가하세요.
|
|
```
|
|
|
|
## 5단계: 설치 및 실행
|
|
|
|
```bash
|
|
crewai install
|
|
crewai run
|
|
```
|
|
|
|
실행이 끝나면 `output/report.md`를 확인하세요.
|
|
|
|
<Warning>
|
|
신뢰하는 출처의 JSON crew 프로젝트만 실행하세요. `custom:<name>` 도구와 `{"python": "module.attribute"}` 참조는 crew 로드 시 로컬 Python 코드를 실행합니다.
|
|
</Warning>
|
|
|
|
<Check>
|
|
주제를 조사하고 보고서를 작성하는 JSON-first crew를 만들었습니다.
|
|
</Check>
|