AGENTS.md - Ein einfaches, offenes Format zur Anleitung von Codierungsagenten

AGENTS.md ist ein einfaches, offenes Format, das dazu dient, Codierungsagenten zu leiten und von über 20.000 Open-Source-Projekten genutzt wird. Es dient als spezieller Raum zur Bereitstellung von Kontext und Anweisungen, die AI-Codierungsagenten helfen, effektiv an Projekten zu arbeiten. Dieses Format ergänzt traditionelle README.md-Dateien, indem es sich auf die spezifischen Bedürfnisse von Codierungsagenten konzentriert.

1. Setup-Befehle

   • Abhängigkeiten installieren: pnpm install
   • Entwicklungsserver starten: pnpm dev
   • Tests ausführen: pnpm test

2. Richtlinien für den Code-Stil

   • TypeScript-Strengmodus
   • Einfache Anführungszeichen, keine Semikolons
   • Vorliebe für funktionale Programmiermuster

3. Agentenkompatibilität

   AGENTS.md funktioniert nahtlos mit verschiedenen AI-Codierungsagenten, einschließlich:

   Agentenname	Beschreibung
   Codex	Allgemeines CLI-Tool für AI-Codierungsagenten.
   Amp	AI-Codierungsagent von Google.
   Jules	Ein weiterer AI-Codierungsagent von Google.
   Cursor	AI-Codierungswerkzeug für erhöhte Produktivität.
   Factory	Werkzeug zum Erstellen und Verwalten von Codierungsagenten.
   Roo	AI-Codierungsassistent für verschiedene Programmieraufgaben.
   CodeAider	AI-Werkzeug für Codeunterstützung und -generierung.
   Gemini CLI	CLI-Werkzeug von Google für Codierungsaufgaben.
   Kilo Code	AI-Codierungsagent für optimierte Entwicklung.
   OpenCode	Open-Source-Codierungsagent für kollaborative Projekte.
   Phoenix	AI-Werkzeug zur Verbesserung der Codierungseffizienz.
   Zed	AI-Codierungsassistent für verschiedene Programmiersprachen.

4. Verschachtelte AGENTS.md-Dateien

   Für große Monorepos können verschachtelte AGENTS.md-Dateien innerhalb von Teilprojekten verwendet werden, um maßgeschneiderte Anweisungen für jedes Paket bereitzustellen.

1. Erstellen Sie eine AGENTS.md-Datei im Stammverzeichnis Ihres Repositories.
2. Fügen Sie Abschnitte hinzu, die den Agenten helfen, effektiv zu arbeiten, wie Projektübersicht, Build-Befehle und Testanweisungen.
3. Fügen Sie alle zusätzlichen Anweisungen hinzu, die für neue Mitwirkende relevant sind, wie Commit-Nachrichten und Sicherheitsüberlegungen.
4. Nutzen Sie für große Projekte verschachtelte AGENTS.md-Dateien für spezifische Teilprojekte, um lokale Anleitungen bereitzustellen.

Gibt es erforderliche Felder in AGENTS.md?

Nein, AGENTS.md ist flexibel und kann nach Bedarf mit beliebigen Überschriften strukturiert werden. Der Agent wird den bereitgestellten Text analysieren.

Was passiert, wenn Anweisungen in Konflikt stehen?

Die nächstgelegene AGENTS.md-Datei zur bearbeiteten Datei hat Vorrang, während explizite Benutzeraufforderungen widersprüchliche Anweisungen überschreiben.

Wird der Agent Testbefehle automatisch ausführen?

Ja, wenn Testbefehle in AGENTS.md aufgeführt sind, wird der Agent versuchen, sie auszuführen und etwaige Fehler zu beheben.

Kann AGENTS.md später aktualisiert werden?

Absolut, AGENTS.md sollte als lebendige Dokumentation betrachtet werden, die nach Bedarf geändert werden kann.

Preisdaten sind noch nicht verfügbar; bitte besuchen Sie die offizielle Website für weitere Informationen.

1. AGENTS.md bietet effektiv ein strukturiertes Format für Codierungsagenten, das deren Fähigkeit verbessert, Projektanforderungen zu verstehen und Aufgaben effizient auszuführen.
2. Die Trennung von README.md-Dateien hilft, Klarheit für menschliche Mitwirkende zu bewahren, während detaillierte Anleitungen für AI-Agenten angeboten werden.
3. Die Einführung von AGENTS.md kann jedoch einen kulturellen Wandel innerhalb von Teams erfordern, die an traditionelle Dokumentationspraktiken gewöhnt sind.
4. Insgesamt ist AGENTS.md ein wertvolles Werkzeug für Entwickler, die ihre Arbeitsabläufe mit AI-Codierungsagenten optimieren möchten, aber der Erfolg hängt von konsistenter Nutzung und Aktualisierungen ab.