AGENTS.md, un format simple et ouvert pour guider les agents de codage IA, qui fournit le contexte et les instructions pour les aider à travailler sur votre projet, utilisé par plus de 20k projets open sourceAGENTS.md est un format simple et ouvert pour guider les agents de codage d'intelligence artificielle (IA). AGENTS.md peut être considéré comme un README pour les agents : un endroit dédié et prévisible pour fournir le contexte et les instructions qui aideront les agents de codage IA à travailler sur votre projet.
AGENTS.md est le fruit d'efforts de collaboration au sein de l'écosystème de développement de logiciels d'IA, notamment OpenAI Codex, Amp, Jules de Google, Cursor et Factory. Les créateurs du projet se sont engagés à contribuer au maintien et à l'évolution de ce format ouvert qui profite à l'ensemble de la communauté des développeurs, quel que soit l'agent de codage utilisé.
Pourquoi AGENTS.md ?
Les fichiers README.md sont généralement destinés aux humains : démarrages rapides, descriptions de projets et directives de contribution. AGENTS.md complète ces fichiers en fournissant le contexte supplémentaire, parfois détaillé, dont les agents de codage ont besoin : les étapes de construction, les tests et les conventions qui pourraient encombrer un README ou qui ne sont pas pertinentes pour les contributeurs humains.
Ces informations ont été volontairement séparées pour :
- Donner aux agents un endroit clair et prévisible pour les instructions.
- Garder les README concis et centrés sur les contributeurs humains.
- Fournir des conseils précis, axés sur les agents, qui complètent les README et les documents existants.
Ainsi, plutôt que d'introduire un autre fichier propriétaire, les créateurs d'AGENTS.md ont choisi un nom et un format qui peuvent convenir à tout le monde.
Exemples
Ci-dessous figure un exemple minimal de fichier AGENTS.md :
| Code : | Sélectionner tout |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | # Sample AGENTS.md file ## Dev environment tips - Use `pnpm dlx turbo run where <project_name>` to jump to a package instead of scanning with `ls`. - Run `pnpm install --filter <project_name>` to add the package to your workspace so Vite, ESLint, and TypeScript can see it. - Use `pnpm create vite@latest <project_name> -- --template react-ts` to spin up a new React + Vite package with TypeScript checks ready. - Check the name field inside each package's package.json to confirm the right name—skip the top-level one. ## Testing instructions - Find the CI plan in the .github/workflows folder. - Run `pnpm turbo run test --filter <project_name>` to run every check defined for that package. - From the package root you can just call `pnpm test`. The commit should pass all tests before you merge. - To focus on one step, add the Vitest pattern: `pnpm vitest run -t "<test name>"`. - Fix any test or type errors until the whole suite is green. - After moving files or changing imports, run `pnpm lint --filter <project_name>` to be sure ESLint and TypeScript rules still pass. - Add or update tests for the code you change, even if nobody asked. ## PR instructions - Title format: [ |
Comment utiliser AGENTS.md ?
1. Ajout d'un fichier AGENTS.md
Créez un fichier AGENTS.md à la racine du référentiel. La plupart des agents de codage peuvent même en créer un pour vous si vous le demandez gentiment.
2. Couvrir ce qui est important
Ajoutez des sections qui aideront un agent à travailler efficacement sur votre projet. Les choix populaires sont :
- Vue d'ensemble du projet
- Commandes de construction et de test
- Directives de style de code
- Instructions de test
- Considérations de sécurité
3. Ajout des instructions supplémentaires
Tout ce que l'on dit à un nouveau membre de l'équipe peut trouver sa place ici (messages de validation ou directives de demande d'extraction, problèmes de sécurité, grands ensembles de données, étapes de déploiement, etc.)
4. Grand monorepo ? Utilisez des fichiers AGENTS.md imbriqués pour les sous-projets
Il est possible de placer un autre fichier AGENTS.md dans chaque paquet. Les agents lisent automatiquement le fichier le plus proche dans l'arborescence des répertoires, de sorte que celui-ci est prioritaire et que chaque sous-projet peut envoyer des instructions personnalisées. Par exemple, au moment de l'écriture, le repo principal d'OpenAI contenait 88 fichiers AGENTS.md.
Exécution en local
Pour exécuter l'application localement, il faudra :
1. Installer les dépendances :
| Code : | Sélectionner tout |
npm install
2. Démarrer le serveur de développement :
| Code : | Sélectionner tout |
npm run dev
3. Ouvrir le navigateur et se rendre à http://localhost:3000
FAQ
Y a-t-il des champs obligatoires ?
Non. AGENTS.md est un fichier Markdown standard. Utilisez les titres que vous souhaitez ; l'agent analyse simplement le texte que vous lui fournissez.
Que se passe-t-il en cas de conflit d'instructions ?
Le fichier AGENTS.md le plus proche du fichier édité l'emporte ; les invites de chat explicites de l'utilisateur l'emportent sur tout le reste.
L'agent exécutera-t-il automatiquement les commandes de test figurant dans le fichier AGENTS.md ?
Oui, si vous les répertoriez. L'agent tentera d'exécuter les vérifications programmatiques pertinentes et de corriger les échecs avant de terminer la tâche.
Comment puis-je migrer des documents existants vers AGENTS.md ?
Renommez les fichiers existants en AGENTS.md et créez des liens symboliques pour assurer la compatibilité ascendante :
| Code : | Sélectionner tout |
mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md
Source : AGENTS.md
Et vous ?
Quel est votre avis sur le sujet ? Trouvez-vous qu'il s'agit d'une initiative cohérente ou pertinente ? Avez-vous déjà utilisé cet outil ou un outil similaire pour votre usage ou le développement d'applications, et si oui, qu'en pensez-vous ?Voir aussi :
Syncthing 2.0, l'outil open source de synchronisation de fichiers, est disponible, avec une migration vers SQLite, de nouvelles capacités de journalisation, des changements de plateforme et plus encore e2b : un EDI open-source alimenté par des agents d'IA pour effectuer le travail de codage à la place des développeurs, à partir d'une courte documentation ou d'une spécification technique Plandex, un moteur de codage IA pour les tâches complexes, qui utilise des agents à long terme pour effectuer des tâches qui couvrent plusieurs fichiers et nécessitent de nombreuses étapes
Vous avez lu gratuitement 1 735 articles depuis plus d'un an.
Soutenez le club developpez.com en souscrivant un abonnement pour que nous puissions continuer à vous proposer des publications.
Soutenez le club developpez.com en souscrivant un abonnement pour que nous puissions continuer à vous proposer des publications.