AI Tool Atlas
Regras & instruções Oficial

AGENTS.md

Open Markdown format that gives coding agents project instructions, a README for agents read by Codex, Cursor, Gemini CLI, Windsurf and more.

Autor
AGENTS.md (Agentic AI Foundation, Linux Foundation)
Funciona com
Cursor, Gemini CLI, OpenAI Codex, Windsurf
Documentado
Oct 2, 2026
Documentação oficial ↗

O que é AGENTS.md

AGENTS.md is a plain Markdown file placed in a repository to give coding agents build steps, tests and conventions. It has no required fields. Agents read the nearest file in the directory tree, so nested files serve monorepo subprojects. The site says it is stewarded by the Agentic AI Foundation under the Linux Foundation.

O que ela faz

Como o AGENTS.md se integra: quais agentes o executam e o que ele acrescentaEXECUTA EMSeu agenteOpenAI CodexCursorGemini CLIWindsurf4 hosts documentadosRULES · OFICIALAGENTS.mdInstruções do projeto que o agent…5 etapas de instalaçãosem permissões extras listadasO QUE ELA ACRESCENTAO que ela fazGives agents a predictable place…Keeps agent-focused detail out of…Supports nested AGENTS.md files;…Works across many agents with one…agente → extensão → nova capacidade · do repositório ou da documentação oficial
Onde AGENTS.md roda e o que acrescenta, segundo a documentação
  • Gives agents a predictable place for setup, test and code-style instructions
  • Keeps agent-focused detail out of the human README
  • Supports nested AGENTS.md files; the closest one to the edited file wins
  • Works across many agents with one file instead of per-tool formats

Quando usar

Boa adequação

  • You use more than one coding agent on the same repo
  • A monorepo needs per-package agent instructions
  • You want agents to run your listed test commands before finishing

Não indicado para

  • Machine-enforced policy: it is guidance text, and explicit user chat prompts override it

Como instalar o AGENTS.md

Você precisa de: An agent that reads AGENTS.md

  1. Create an AGENTS.md file at the repository root
  2. Add sections such as project overview, build and test commands, code style, testing and PR instructions
  3. For monorepos add another AGENTS.md inside each package
  4. To migrate: mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md
  5. Gemini CLI: set context.fileName to AGENTS.md in .gemini/settings.json; Aider: add read: AGENTS.md to .aider.conf.yml
Exemplo de configuração (da documentação oficial)
{
  "context": {
    "fileName": "AGENTS.md"
  }
}

Limitações

  • No required fields or schema; behavior depends on each agent
  • Conflicts resolved by nearest file, chat prompts override everything

Ferramentas que ela estende

Programação Plano gratuito

OpenAI Codex

Web · Desktop · Mobile

Ainda sem avaliações de usuários

OpenAI's coding agent for the CLI, IDE extension, desktop app, web and iOS, included in ChatGPT plans or billed by API.

O plano gratuito termina em: Desktop app only listed, Usage limits apply

Listed Ainda não avaliada

Verificado developers.openai.com (abre o site de OpenAI Codex em uma nova aba)

Grátis · pago a partir de $8/mo EUA · verificado Sep 29

CompareAdded OpenAI Codex Detalhes cerca de OpenAI Codex
Programação

Gemini CLI

Desktop

Ainda sem avaliações de usuários

Agente de IA de terminal de código aberto do Google que leva o Gemini à linha de comando; o site informa que usuários sem plano pago e do Google One foram movidos para o Antigravity CLI.

O plano gratuito termina em: Verify current availability

Listed Ainda não avaliada

Verificado geminicli.com (abre o site de Gemini CLI em uma nova aba)

Preços Preço nos EUA não confirmado

CompareAdded Gemini CLI Detalhes cerca de Gemini CLI
Programação Plano gratuito
Ainda sem avaliações de usuários

AI coding IDE, formerly Windsurf, now Devin Desktop: manage local and cloud coding agents inside a full IDE.

O plano gratuito termina em: Light quota for agent usage, resets daily and weekly, Limited model availability

Listed Ainda não avaliada

Verificado windsurf.com (abre o site de Devin Desktop (formerly Windsurf) em uma nova aba)

Grátis · pago a partir de $20/mo EUA · verificado Sep 29

CompareAdded Devin Desktop (formerly Windsurf) Detalhes cerca de Devin Desktop (formerly Windsurf)

Perguntas frequentes

Are there required fields in AGENTS.md?

No. It is standard Markdown; use any headings you like. fonte

What happens when AGENTS.md files conflict?

The closest AGENTS.md to the edited file wins, and explicit user chat prompts override everything. fonte

How do I make Gemini CLI read AGENTS.md?

Set context.fileName to AGENTS.md in .gemini/settings.json. fonte

Which agents support AGENTS.md?

The site lists Codex, Jules, Factory, Aider, goose, opencode, Zed, Warp, VS Code, Devin, Junie, Amp, Cursor, RooCode, Gemini CLI, Kilo Code, Copilot coding agent, Windsurf and others. fonte

Guias relacionados

Fontes e lacunas

Não informado pelos mantenedores: Repo URL and license not fetched from the page; repo_url is the project's GitHub org repo, unverified; Codex-specific AGENTS.md discovery rules not read; Public source repository (closed source or not verified).

Mais extensões para conhecer