mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-09-23 19:30:45 +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.3 KiB
Plaintext
66 lines
3.3 KiB
Plaintext
---
|
|
title: Ferramentas de Codificação
|
|
description: Use o AGENTS.md para guiar agentes de codificação e IDEs em seus projetos CrewAI.
|
|
icon: terminal
|
|
mode: "wide"
|
|
---
|
|
|
|
## Por que AGENTS.md
|
|
|
|
`AGENTS.md` é um arquivo de instruções leve e local do repositório que fornece aos agentes de codificação orientações consistentes e específicas do projeto. Mantenha-o na raiz do projeto e trate-o como a fonte da verdade para como você deseja que os assistentes trabalhem: convenções, comandos, notas de arquitetura e proteções.
|
|
|
|
## Criar um Projeto com o CLI
|
|
|
|
Use o CLI do CrewAI para criar a estrutura de um projeto. O `AGENTS.md` é adicionado na raiz, junto com um `CLAUDE.md` e um `GEMINI.md` que o importam, para que o Claude Code e o Gemini CLI leiam a mesma orientação que todos os outros assistentes.
|
|
|
|
```bash
|
|
# Crew
|
|
crewai create crew my_crew
|
|
|
|
# Flow
|
|
crewai create flow my_flow
|
|
|
|
# Tool repository
|
|
crewai tool create my_tool
|
|
```
|
|
|
|
## Configuração de Ferramentas: Direcione Assistentes para o AGENTS.md
|
|
|
|
### Codex
|
|
|
|
O Codex pode ser guiado por arquivos `AGENTS.md` colocados no seu repositório. Use-os para fornecer contexto persistente do projeto, como convenções, comandos e expectativas de fluxo de trabalho.
|
|
|
|
### Claude Code
|
|
|
|
O Claude Code lê o `CLAUDE.md` e ignora o `AGENTS.md`. Projetos gerados pelo CLI já incluem um `CLAUDE.md` cuja única instrução é a linha de importação `@AGENTS.md`, para que a orientação compartilhada seja carregada sem duplicação. Adicione notas específicas do Claude abaixo dessa linha e mantenha as convenções compartilhadas no `AGENTS.md`.
|
|
|
|
Para um projeto criado antes de o `CLAUDE.md` passar a ser gerado, adicione a importação você mesmo:
|
|
|
|
```bash
|
|
printf '@AGENTS.md\n' > CLAUDE.md
|
|
```
|
|
|
|
Não renomeie o `AGENTS.md` para `CLAUDE.md`: o Codex e o Cursor leem o `AGENTS.md`, e a renomeação o esconde deles.
|
|
|
|
### Gemini CLI e Google Antigravity
|
|
|
|
O Gemini CLI e o Antigravity carregam um arquivo de contexto do projeto (padrão: `GEMINI.md`) da raiz do repositório e diretórios pais. Projetos gerados pelo CLI já incluem um `GEMINI.md` cuja única instrução é a linha de importação `@./AGENTS.md`, para que a orientação compartilhada seja carregada sem duplicação. Adicione notas específicas do Gemini abaixo dessa linha e mantenha as convenções compartilhadas no `AGENTS.md`.
|
|
|
|
Para um projeto criado antes de o `GEMINI.md` passar a ser gerado, adicione a importação você mesmo:
|
|
|
|
```bash
|
|
printf '@./AGENTS.md\n' > GEMINI.md
|
|
```
|
|
|
|
Como alternativa, defina `context.fileName` nas configurações do Gemini CLI para incluir o `AGENTS.md` e o Gemini o lerá diretamente. Não renomeie o `AGENTS.md` para `GEMINI.md`: o Codex e o Cursor leem o `AGENTS.md`, e a renomeação o esconde deles.
|
|
|
|
### Cursor
|
|
|
|
O Cursor suporta `AGENTS.md` como arquivo de instruções do projeto. Coloque-o na raiz do projeto para fornecer orientação ao assistente de codificação do Cursor.
|
|
|
|
### Windsurf
|
|
|
|
O Claude Code fornece uma integração oficial com o Windsurf. Se você usa o Claude Code dentro do Windsurf, siga a orientação do Claude Code acima e importe o `AGENTS.md` a partir do `CLAUDE.md`.
|
|
|
|
Se você está usando o assistente nativo do Windsurf, configure o recurso de regras ou instruções do projeto (se disponível) para ler o `AGENTS.md` ou cole o conteúdo diretamente.
|