Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.devinenterprise.com/llms.txt

Use this file to discover all available pages before exploring further.

Les fichiers AGENTS.md permettent simplement de fournir à Cascade des instructions adaptées au contexte, qui s’appliquent automatiquement selon l’emplacement du fichier dans votre projet. C’est particulièrement utile pour définir des directives de code propres à un répertoire, des décisions architecturales ou des conventions de projet.

​
Comment ça fonctionne

Lorsque vous créez un fichier AGENTS.md (ou agents.md), Devin Desktop le détecte automatiquement et l’intègre au même moteur de Règles que celui utilisé par .windsurf/rules/ — à ceci près que le mode d’activation est déduit de l’emplacement du fichier plutôt que du frontmatter :
  • Répertoire racine : traité comme une règle toujours active — l’intégralité du contenu est incluse dans le prompt système de Cascade à chaque message.
  • Sous-répertoires : traités comme une règle glob avec un motif généré automatiquement de <directory>/** — le contenu n’est appliqué que lorsque Cascade lit ou modifie des fichiers dans ce répertoire.
Ce périmètre basé sur l’emplacement fait de AGENTS.md un excellent moyen de fournir des indications ciblées sans encombrer un unique fichier de configuration global.

​
Création d’un fichier AGENTS.md

Créez simplement un fichier nommé AGENTS.md ou agents.md dans le répertoire souhaité. Le fichier est rédigé en Markdown simple, sans frontmatter particulier.

​
Exemple de structure

my-project/
├── AGENTS.md                    # Instructions globales pour l'ensemble du projet
├── frontend/
│   ├── AGENTS.md                # Instructions spécifiques au code frontend
│   └── src/
│       └── components/
│           └── AGENTS.md        # Instructions spécifiques aux composants
├── backend/
│   └── AGENTS.md                # Instructions spécifiques au code backend
└── docs/
    └── AGENTS.md                # Instructions pour la documentation

​
Exemple de contenu

Voici un exemple de fichier AGENTS.md pour un répertoire de composants React : 
# Directives pour les composants

Lorsque vous travaillez avec des composants dans ce répertoire :

- Utiliser des composants fonctionnels avec des hooks
- Respecter la convention de nommage : ComponentName.tsx pour les composants, useHookName.ts pour les hooks
- Chaque composant doit avoir un fichier de test correspondant : ComponentName.test.tsx
- Utiliser les modules CSS pour le style : ComponentName.module.css
- Exporter les composants en tant qu'exports nommés, et non en tant qu'exports par défaut

## Structure des fichiers

Chaque dossier de composant doit contenir :
- Le fichier principal du composant
- Un fichier de test
- Un fichier de styles (si nécessaire)
- Un fichier index.ts pour les réexports

​
Découverte et périmètre

Devin Desktop détecte automatiquement les fichiers AGENTS.md dans tout votre espace de travail :
  • Analyse de l’espace de travail : tous les fichiers AGENTS.md présents dans votre espace de travail et ses sous-répertoires sont détectés
  • Prise en charge des dépôts Git : pour les dépôts Git, Devin Desktop recherche également dans les répertoires parents jusqu’à la racine du dépôt Git
  • Insensible à la casse : AGENTS.md et agents.md sont tous deux reconnus

​
Périmètre automatique

Le principal avantage de AGENTS.md est le périmètre automatique en fonction de l’emplacement du fichier :
Emplacement du fichierPérimètre
Racine de l’espace de travailS’applique à tous les fichiers (toujours actif)
/frontend/S’applique lorsque vous travaillez sur des fichiers dans /frontend/**
/frontend/components/S’applique lorsque vous travaillez sur des fichiers dans /frontend/components/**
Cela signifie que vous pouvez avoir plusieurs fichiers AGENTS.md à différents niveaux, chacun fournissant des consignes de plus en plus spécifiques pour les répertoires correspondants.

​
Bonnes pratiques

Pour tirer le meilleur parti des fichiers AGENTS.md :
  • Gardez des instructions ciblées : chaque AGENTS.md doit contenir des instructions pertinentes pour le rôle de son répertoire
  • Utilisez une mise en forme claire : les listes à puces, les en-têtes et les blocs de code permettent à Cascade de suivre plus facilement les instructions
  • Soyez précis : des exemples concrets et des conventions explicites sont plus efficaces que des consignes vagues
  • Évitez les redondances : ne répétez pas les instructions globales dans les fichiers de sous-répertoire ; ils héritent de celles des répertoires parents

​
Directives relatives au contenu

# Bon exemple
- Use TypeScript strict mode
- All API responses must include error handling
- Follow REST naming conventions for endpoints

# Exemple moins efficace
- Write good code
- Be careful with errors
- Use best practices

​
Comparaison avec les règles

Bien que AGENTS.md et les Règles fournissent tous deux des instructions à Cascade, ils répondent à des besoins différents :
FonctionnalitéAGENTS.mdRègles
EmplacementDans les répertoires du projet.windsurf/rules/ ou global
PérimètreAutomatique selon l’emplacement du fichierManuel (glob, toujours actif, décision du modèle, manuel)
FormatMarkdown brutMarkdown avec frontmatter
Idéal pourConventions propres à un répertoireBesoins transverses, logique d’activation complexe
Utilisez AGENTS.md si vous souhaitez des instructions simples basées sur l’emplacement. Utilisez les Règles si vous avez besoin de mieux contrôler quand et comment les instructions sont appliquées.