OpenCode-Regeln (AGENTS.md)

In OpenCode sindRegeln der zentrale Mechanismus zur Steuerung des KI-Verhaltens.。

Wir können überAGENTS.mddie Datei benutzerdefinierte Anweisungen an OpenCode bereitstellen, sodass es nach Ihren Projektstandards entwickelt.

Tools bestimmen, was KI tun kann; AGENTS.md bestimmt, wie KI es tun sollte.

AGENTS.md = Festlegung von Team-Entwicklungsstandards für KI.

1. Was ist AGENTS.md

AGENTS.mdEs ist eine Regeldatei, verwendet für:

  • Definieren der Projektstruktur
  • Durchsetzen des Code-Stils
  • Standardisieren des Entwicklungs-Workflows
  • Anleiten der KI, wie Aufgaben ausgeführt werden

Dieser Inhalt wird dem LLM-Kontext hinzugefügt.

Auswirkungen:

  • KI versteht Ihr Projekt besser
  • Generierter Code entspricht besser den Spezifikationen
  • Reduziert wiederholte Überarbeitungen

2. Schnelle Initialisierung

In OpenCode ausführen:

/init

Dieser Befehl wird:

  • Projektstruktur scannen
  • Code-Organisation analysieren
  • AGENTS.md automatisch generieren

Empfehlung:

  • AGENTS.md in Git committen
  • Als einheitlicher Teamstandard

3. Beispielstruktur

# 项目说明

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

## 项目结构

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

## 代码规范

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

## 开发约定

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

Essenz: Teamstandards "für die KI sichtbar" schreiben

4. Geltungsbereich der Regeln

1. Regeln auf Projektebene

Pfad:

./AGENTS.md

Wirkung:

  • Gilt nur für das aktuelle Projekt
  • Vom Team gemeinsam genutzt

2. Globale Regeln

Pfad:

~/.config/opencode/AGENTS.md

Wirkung:

  • Gilt für alle Projekte
  • Persönliche Nutzung

Empfohlene Verwendungen:

  • Persönliche Programmiergewohnheiten
  • Steuerung des Ausgabestils

5. Claude Code-Kompatibilität

OpenCode ist mit dem Regelsystem von Claude Code kompatibel:

  • Projektregeln: CLAUDE.md
  • Globale Regeln: ~/.claude/CLAUDE.md
  • Skills-Verzeichnis: ~/.claude/skills/

Wenn du es nicht verwenden möchtest, kannst du es deaktivieren:

export OPENCODE_DISABLE_CLAUDE_CODE=1

6. Priorität beim Laden von Regeln (Wichtig)

OpenCode lädt Regeln beim Start in der folgenden Reihenfolge:

  1. Vom aktuellen Verzeichnis aus nach oben nach AGENTS.md suchen
  2. Falls nicht gefunden → nach CLAUDE.md suchen
  3. Globale Regeln ~/.config/opencode/AGENTS.md
  4. Globale Claude-Regeln ~/.claude/CLAUDE.md

Wichtige Punkte:

  • AGENTS.md hat die höchste Priorität
  • Auf derselben Ebene wird nur die erste übereinstimmende Datei verwendet

7. Erweiterte Regeln (Anweisungen)

Sie könnenopencode.jsonzusätzliche Regeldateien laden aus:

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

Vorteile:

  • Vorhandene Dokumentation wiederverwenden
  • Doppelte Wartung vermeiden

Unterstützt Remote-Regeln

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

Hinweis:

  • URL-Laden unterstützt
  • Timeout: 5 Sekunden

8. Modulare Regeln (Fortgeschritten)

Empfohlene Methode (unter Verwendung von Anweisungen)

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

Geeignet für:

  • Monorepo
  • Große Projekte

Methode 2: Manuell in AGENTS.md referenzieren

# 规则加载说明

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

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

Beispiel:

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

Implementiere "Regeln bei Bedarf laden"

9. Best Practices (Kernpunkte)

1. Regeln sollten spezifisch sein

❌ Nicht schreiben:

The code should follow standard conventions.

✅ Du solltest schreiben:

所有函数必须添加 JSDoc 注释

2. Regeln sollten ausführbar sein

Eine KI kann nur explizite Regeln ausführen, keine abstrakten Beschreibungen.

3. Mach sie nicht zu lang

Vorschlag:

  • Schreibe Kernregeln in AGENTS.md
  • Lagere detaillierte Regeln in Instructions-Dateien aus

4. Einheitliche Pflege durch das Team

  • Unter Git-Verwaltung stellen
  • Als Teil der Entwicklungsstandards
Weitere Erweiterungen