AI Tool Atlas
Regeln & Anweisungen Offiziell

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)
Funktioniert mit
Cursor, Gemini CLI, OpenAI Codex, Windsurf
Dokumentiert
Oct 2, 2026
Offizielle Doku ↗

Was AGENTS.md ist

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.

Was es kann

Wie sich AGENTS.md einbinden lässt: welche Agenten es ausführen und was es ergänztLÄUFT INIhr AgentOpenAI CodexCursorGemini CLIWindsurf4 Hosts dokumentiertRULES · OFFIZIELLAGENTS.mdProjektanweisungen, die der Agent…5 Installationsschrittekeine zusätzlichen Berechtigungen…WAS ES ERGÄNZTWas es kannGives agents a predictable place…Keeps agent-focused detail out of…Supports nested AGENTS.md files;…Works across many agents with one…Agent → Erweiterung → neue Fähigkeit · aus dem offiziellen Repository oder der Dokumentation
Wo AGENTS.md läuft und was es ergänzt, laut Dokumentation
  • 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

Wann Sie es einsetzen sollten

Gut geeignet

  • 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

Nicht geeignet für

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

So installieren Sie AGENTS.md

Sie benötigen: 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
Konfigurationsbeispiel (aus der offiziellen Dokumentation)
{
  "context": {
    "fileName": "AGENTS.md"
  }
}

Einschränkungen

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

Tools, die es erweitert

Coding Kostenloser Tarif

OpenAI Codex

Web · Desktop · Mobile

Noch keine Nutzerbewertungen

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

Kostenlos bis: Desktop app only listed, Usage limits apply

Listed Noch nicht bewertet

Geprüft developers.openai.com (öffnet die Website von OpenAI Codex in einem neuen Tab)

Kostenlos · kostenpflichtig ab $8/mo US · geprüft Sep 29

CompareAdded OpenAI Codex Details etwa OpenAI Codex
Coding Kostenloser Tarif
Noch keine Nutzerbewertungen

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

Kostenlos bis: Light quota for agent usage, resets daily and weekly, Limited model availability

Listed Noch nicht bewertet

Geprüft windsurf.com (öffnet die Website von Devin Desktop (formerly Windsurf) in einem neuen Tab)

Kostenlos · kostenpflichtig ab $20/mo US · geprüft Sep 29

CompareAdded Devin Desktop (formerly Windsurf) Details etwa Devin Desktop (formerly Windsurf)

Häufig gestellte Fragen

Are there required fields in AGENTS.md?

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

What happens when AGENTS.md files conflict?

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

How do I make Gemini CLI read AGENTS.md?

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

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. Quelle

Verwandte Ratgeber

Quellen und Lücken

Von den Maintainern nicht angegeben: 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).

Weitere Erweiterungen zum Ansehen