- AGENTS.md complète le README et sert de fichier dédié contenant le contexte et les instructions dont les agents de codage IA ont besoin lorsqu’ils travaillent sur un projet
- Déjà utilisé dans plus de 20 000 projets open source, il regroupe des informations importantes pour les agents, mais inutiles pour les humains, comme le build, les tests ou le style de code
- Il fournit des instructions dédiées aux agents dans un emplacement clair et prévisible, ce qui permet de garder le README concis tout en renforçant l’efficacité de la collaboration
- Un seul fichier AGENTS.md est compatible avec divers agents et outils, et dans les grands monorepos, il est possible d’utiliser un AGENTS.md distinct par sous-projet
- Un standard ouvert conçu grâce à la collaboration de plusieurs écosystèmes, dont OpenAI Codex, Cursor et Google Jules
Why AGENTS.md?
- README.md est une documentation pour les humains : démarrage rapide, présentation du projet et consignes de contribution
- AGENTS.md est une documentation complémentaire pour les agents ; il contient un contexte détaillé comme les règles de build, de test et de code, sans alourdir le README
- Pourquoi un fichier séparé ?
- Fournir aux agents un emplacement prévisible pour les instructions
- Garder le README concis et centré sur les contributeurs humains
- Fournir des instructions précises dédiées aux agents en complément de la documentation existante
- Adoption d’un nom de standard ouvert que tout le monde peut utiliser, et non d’un format propriétaire
- Un seul AGENTS.md permet une compatibilité avec plusieurs agents de codage IA et outils
How to use AGENTS.md?
- 1. Créer le fichier AGENTS.md
- Le placer à la racine du dépôt (de nombreux agents prennent en charge sa création automatique)
- 2. Rédiger les sections principales
- Vue d’ensemble du projet
- Commandes de build et de test
- Consignes de style de code
- Méthode de test
- Considérations de sécurité
- 3. Ajouter des instructions supplémentaires
- Tout ce que vous transmettriez à un membre de l’équipe : règles de commit/PR, précautions de sécurité, grands jeux de données, étapes de déploiement, etc.
- 4. Gérer les monorepos
- Il est possible de placer un AGENTS.md pour chaque package
- Les agents lisent le fichier le plus proche et suivent les instructions adaptées au sous-projet concerné
- Exemple : le dépôt d’OpenAI contient 88 fichiers AGENTS.md
FAQ
- Éléments obligatoires : aucun, le format Markdown classique peut être utilisé librement
- En cas de conflit : le fichier AGENTS.md le plus proche prévaut, et le prompt explicite de l’utilisateur s’applique en dernier ressort
- Exécution automatique : les commandes de test indiquées dans le fichier peuvent être exécutées par l’agent pour tenter de corriger les erreurs
- Possibilité de mise à jour : modifiable à tout moment, à gérer comme un document vivant
- Migration depuis la documentation existante : conserver la compatibilité via un lien symbolique après changement de nom du fichier
mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md
Aucun commentaire pour le moment.