mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-09-21 10:26:25 +00:00
6b6a39d503
* feat: scaffold project with assistant instruction files - Updated project creation to include `CLAUDE.md` and `GEMINI.md` that import `AGENTS.md`, ensuring consistent guidance across coding assistants. - Implemented utility functions to copy assistant instruction files during project setup. - Enhanced documentation in `AGENTS.md` to emphasize the importance of keeping telemetry enabled for optimal performance. - Added tests to verify the correct scaffolding of assistant instruction files and their contents. * fix(cli): neutral observability guidance in scaffolded AGENTS.md - State the observability rule as the user's decision, never a fix for console warnings, speed, or a "clean" configuration - Rewrite the AMP section as built-in capabilities: no "free", "proactively", "sales pitch", or scripted pitches - Turn the research mandate into a list of sources to consult when version details matter - Retarget the scaffold tests to the new wording Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> * fix(cli): scaffold assistant files for JSON crews and harden telemetry tests - create_json_crew, the default `crewai create crew` path, now copies AGENTS.md, CLAUDE.md and GEMINI.md; AGENTS.md documents the JSON layout - span helper no longer depends on OTEL_SDK_DISABLED being popped by an earlier test; thread-scope test stops its worker before leaving the mock - single import style in the shutdown test Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
66 lines
3.4 KiB
Plaintext
66 lines
3.4 KiB
Plaintext
---
|
|
title: 코딩 도구
|
|
description: AGENTS.md를 사용하여 CrewAI 프로젝트 전반에서 코딩 에이전트와 IDE를 안내합니다.
|
|
icon: terminal
|
|
mode: "wide"
|
|
---
|
|
|
|
## AGENTS.md를 사용하는 이유
|
|
|
|
`AGENTS.md`는 가벼운 저장소 로컬 지침 파일로, 코딩 에이전트에게 일관되고 프로젝트별 안내를 제공합니다. 프로젝트 루트에 배치하고 어시스턴트가 작업하는 방식(컨벤션, 명령어, 아키텍처 노트, 가드레일)에 대한 신뢰할 수 있는 소스로 활용하세요.
|
|
|
|
## CLI로 프로젝트 생성
|
|
|
|
CrewAI CLI를 사용하여 프로젝트를 스캐폴딩하세요. `AGENTS.md`가 루트에 추가되며, 이를 임포트하는 `CLAUDE.md`와 `GEMINI.md`도 함께 추가되므로 Claude Code와 Gemini CLI가 다른 모든 어시스턴트와 동일한 안내를 읽습니다.
|
|
|
|
```bash
|
|
# Crew
|
|
crewai create crew my_crew
|
|
|
|
# Flow
|
|
crewai create flow my_flow
|
|
|
|
# Tool repository
|
|
crewai tool create my_tool
|
|
```
|
|
|
|
## 도구 설정: 어시스턴트에 AGENTS.md 연결
|
|
|
|
### Codex
|
|
|
|
Codex는 저장소에 배치된 `AGENTS.md` 파일로 안내할 수 있습니다. 컨벤션, 명령어, 워크플로우 기대치 등 지속적인 프로젝트 컨텍스트를 제공하는 데 사용하세요.
|
|
|
|
### Claude Code
|
|
|
|
Claude Code는 `CLAUDE.md`를 읽고 `AGENTS.md`는 무시합니다. 스캐폴딩된 프로젝트에는 임포트 줄 `@AGENTS.md` 하나만 담긴 `CLAUDE.md`가 포함되어 있어, 공유 안내가 중복 없이 로드됩니다. Claude 전용 메모는 그 줄 아래에 추가하고, 공유 컨벤션은 `AGENTS.md`에 유지하세요.
|
|
|
|
`CLAUDE.md`가 스캐폴딩되기 전에 생성된 프로젝트라면 임포트를 직접 추가하세요:
|
|
|
|
```bash
|
|
printf '@AGENTS.md\n' > CLAUDE.md
|
|
```
|
|
|
|
`AGENTS.md`를 `CLAUDE.md`로 이름을 바꾸지 마세요. Codex와 Cursor는 `AGENTS.md`를 읽으며, 이름을 바꾸면 이들에게 보이지 않게 됩니다.
|
|
|
|
### Gemini CLI와 Google Antigravity
|
|
|
|
Gemini CLI와 Antigravity는 저장소 루트 및 상위 디렉토리에서 프로젝트 컨텍스트 파일(기본값: `GEMINI.md`)을 로드합니다. 스캐폴딩된 프로젝트에는 임포트 줄 `@./AGENTS.md` 하나만 담긴 `GEMINI.md`가 포함되어 있어, 공유 안내가 중복 없이 로드됩니다. Gemini 전용 메모는 그 줄 아래에 추가하고, 공유 컨벤션은 `AGENTS.md`에 유지하세요.
|
|
|
|
`GEMINI.md`가 스캐폴딩되기 전에 생성된 프로젝트라면 임포트를 직접 추가하세요:
|
|
|
|
```bash
|
|
printf '@./AGENTS.md\n' > GEMINI.md
|
|
```
|
|
|
|
또는 Gemini CLI 설정의 `context.fileName`에 `AGENTS.md`를 포함시키면 Gemini가 이를 직접 읽습니다. `AGENTS.md`를 `GEMINI.md`로 이름을 바꾸지 마세요. Codex와 Cursor는 `AGENTS.md`를 읽으며, 이름을 바꾸면 이들에게 보이지 않게 됩니다.
|
|
|
|
### Cursor
|
|
|
|
Cursor는 `AGENTS.md`를 프로젝트 지침 파일로 지원합니다. 프로젝트 루트에 배치하여 Cursor의 코딩 어시스턴트에 안내를 제공하세요.
|
|
|
|
### Windsurf
|
|
|
|
Claude Code는 Windsurf와의 공식 통합을 제공합니다. Windsurf 내에서 Claude Code를 사용하는 경우, 위의 Claude Code 안내를 따르고 `CLAUDE.md`에서 `AGENTS.md`를 임포트하세요.
|
|
|
|
Windsurf의 네이티브 어시스턴트를 사용하는 경우, 프로젝트 규칙 또는 지침 기능(사용 가능한 경우)을 구성하여 `AGENTS.md`에서 읽거나 내용을 직접 붙여넣으세요.
|