Règles OpenCode (AGENTS.md)

Dans OpenCode,les Règles sont le mécanisme central pour contrôler le comportement de l’IA.。

Nous pouvons, viaAGENTS.mdle fichier, fournir des instructions personnalisées à OpenCode, lui permettant de se développer selon les standards de votre projet.

Les outils déterminent ce que l’IA peut faire ; AGENTS.md détermine comment l’IA doit le faire.

AGENTS.md = Définir des standards de développement d’équipe pour l’IA.

1. Qu'est-ce que AGENTS.md

AGENTS.mdIl s'agit d'un fichier de règles, utilisé pour :

  • Définir la structure du projet
  • Imposer le style de code
  • Normaliser le flux de développement
  • Guider l'IA sur la façon d'exécuter les tâches

Ce contenu sera ajouté au contexte du LLM.

Effets :

  • L'IA comprend mieux votre projet
  • Le code généré est plus conforme aux spécifications
  • Réduit les révisions répétées

2. Initialisation rapide

Exécuter dans OpenCode :

/init

Cette commande permet de :

  • Analyser la structure de votre projet
  • Analyser l’organisation du code
  • Générer automatiquement AGENTS.md

Recommandation :

  • Commiter AGENTS.md dans Git
  • Comme standard d’équipe unifié

3. Exemple de structure

# 项目说明

这是一个基于 TypeScript 的 monorepo 项目。

## 项目结构

- packages/ 核心模块
- infra/ 基础设施
- web/ 前端应用

## 代码规范

- 使用 TypeScript 严格模式
- 公共代码放在 packages/core
- 所有函数必须添加注释

## 开发约定

- 使用 workspace 方式引用模块
- API 必须统一错误处理

Essence : écrire les standards d’équipe « pour que l’IA les voie »

4. Portée des règles

1. Règles au niveau du projet

Chemin :

./AGENTS.md

Effet :

  • S’applique uniquement au projet actuel
  • Partagé par l’équipe

2. Règles globales

Chemin :

~/.config/opencode/AGENTS.md

Effet :

  • S'applique à tous les projets
  • Usage personnel

Utilisations suggérées :

  • Habitudes personnelles de codage
  • Contrôle du style de sortie

5. Compatibilité avec Claude Code

OpenCode est compatible avec le système de règles de Claude Code :

  • Règles de projet : CLAUDE.md
  • Règles globales : ~/.claude/CLAUDE.md
  • Répertoire des compétences : ~/.claude/skills/

Si vous ne souhaitez pas l'utiliser, vous pouvez le désactiver :

export OPENCODE_DISABLE_CLAUDE_CODE=1

6. Priorité de chargement des règles (Important)

OpenCode charge les règles dans l'ordre suivant au démarrage :

  1. Rechercher AGENTS.md en remontant depuis le répertoire courant
  2. Si introuvable → rechercher CLAUDE.md
  3. Règles globales ~/.config/opencode/AGENTS.md
  4. Règles globales de Claude ~/.claude/CLAUDE.md

Points clés :

  • AGENTS.md a la priorité la plus élevée
  • Au même niveau, seul le premier fichier correspondant est utilisé

7. Règles étendues (instructions)

Vous pouvezopencode.jsoncharger des fichiers de règles supplémentaires depuis :

{
  "instructions": [
    "CONTRIBUTING.md",
    "docs/guidelines.md",
    ".cursor/rules/*.md"
  ]
}

Avantages :

  • Réutiliser la documentation existante
  • Éviter la maintenance en double

Prend en charge les règles distantes

{
  "instructions": [
    "https://raw.githubusercontent.com/xxx/rules/main/style.md"
  ]
}

Remarque :

  • Chargement d'URL pris en charge
  • Délai d'attente : 5 secondes

8. Règles modulaires (avancé)

Méthode recommandée (en utilisant des instructions)

{
  "instructions": [
    "docs/dev.md",
    "test/rules.md",
    "packages/*/AGENTS.md"
  ]
}

Adapté à :

  • monorepo
  • Grands projets

Méthode 2 : référencer manuellement dans AGENTS.md

# 规则加载说明

当遇到 @xxx 文件时，请使用 read 工具加载。

- 不要一次性加载全部文件
- 按需加载
- 加载后必须遵守

Exemple :

TypeScript 规范：@docs/typescript.md
React 规范：@docs/react.md
API 规范：@docs/api.md

Implémenter "charger les règles à la demande"

9. Bonnes pratiques (points clés)

1. Les règles doivent être spécifiques

❌ N'écrivez pas :

The code should follow standard conventions.

✅ Vous devriez écrire :

所有函数必须添加 JSDoc 注释

2. Les règles doivent être exécutables

L'IA ne peut exécuter que des règles explicites, pas des descriptions abstraites.

3. Ne les rendez pas trop longues

Suggestion :

  • Écrire les règles principales dans AGENTS.md
  • Répartir les règles détaillées dans des fichiers d'instructions

4. Maintenues de manière uniforme par l'équipe

  • Placer sous gestion Git
  • Dans le cadre des normes de développement
Autres extensions