Description
AGENTS.md est un format simple et ouvert pour guider les agents de codage, utilisé par plus de 60k projets open-source. Pensez-y comme un README pour les agents. Les fichiers README.md traditionnels sont adaptés aux contributeurs humains, offrant des démarrages rapides, des descriptions de projet et des directives de contribution. AGENTS.md complète cela en fournissant le contexte supplémentaire, parfois détaillé, dont les agents de codage ont besoin, comme les étapes de construction, les tests et les conventions qui peuvent encombrer un README ou ne sont pas pertinents pour les contributeurs humains.
La séparation d'AGENTS.md de README.md sert plusieurs objectifs. Elle donne aux agents un endroit clair et prévisible pour les instructions, maintient les README concis et axés sur les contributeurs humains, et fournit des conseils précis, centrés sur les agents, qui complètent les README et la documentation existants. Plutôt que d'introduire un autre fichier propriétaire, AGENTS.md adopte un nom et un format qui peuvent être utilisés par quiconque. Si vous construisez ou utilisez des agents de codage et trouvez ce format utile, vous êtes encouragé à l'adopter.
Un fichier AGENTS.md est compatible avec de nombreux agents, ce qui en fait un outil polyvalent pour les développeurs. Les définitions d'agents que vous créez peuvent fonctionner sans problème avec un écosystème croissant d'agents de codage et d'outils AI, y compris openai/codex, apache/airflow, temporalio/sdk-java et PlutoLang/Pluto. Pour utiliser efficacement AGENTS.md, vous devez ajouter le fichier à votre projet et couvrir ce qui est important en incluant des sections qui aident un agent à travailler efficacement. Les choix populaires pour ces sections incluent un aperçu du projet, des commandes de construction et de test, des directives de style de code, des instructions de test et des considérations de sécurité.
AGENTS.md a émergé des efforts collaboratifs au sein de l'écosystème de développement de logiciels AI, y compris des contributions d'OpenAI Codex, Amp, Jules de Google, Cursor et Factory. Le format est désormais géré par la Fondation Agentic AI sous la Fondation Linux, avec un engagement à le maintenir et à l'évoluer en tant que format ouvert qui bénéficie à l'ensemble de la communauté des développeurs, quel que soit l'agent de codage utilisé.
Fonctionnalités principales de AGENTS.md
Format Ouvert
Compatible avec plusieurs agents
Contexte détaillé pour les agents de codage
Prend en charge les fichiers AGENTS.md imbriqués
Conseils pour des instructions spécifiques au projet
Développement piloté par la communauté
Géré par la Fondation Agentic AI
Facilite la collaboration entre projets
Comment utiliser AGENTS.md ?
Ajouter AGENTS.md : Incluez le fichier AGENTS.md dans votre projet.
Couvrir ce qui est important : Ajoutez des sections qui aident un agent à travailler efficacement avec votre projet.
Ajouter des instructions supplémentaires : Fournissez des conseils supplémentaires si nécessaire.
Utiliser des fichiers imbriqués : Pour de grands monorepos, mettez en œuvre des fichiers AGENTS.md imbriqués pour les sous-projets.
Cas d'utilisation de AGENTS.md
- Documentation de Projet
- Collaboration Open Source
- Configuration d'Agent
- Instructions de Test
- Étapes de Construction
