Deutsch
Dokumentation
Regeln

Rules

Legen Sie benutzerdefinierte Anweisungen für opencode fest.

Sie können opencode benutzerdefinierte Anweisungen bereitstellen, indem Sie eine AGENTS.md Datei erstellen. Dies ist ähnlich wie Cursors Rules. Sie enthält Anweisungen, die in den Kontext des LLM aufgenommen werden, um sein Verhalten für Ihr spezifisches Projekt anzupassen.


Initialisieren

Um eine neue AGENTS.md Datei zu erstellen, können Sie den /init Befehl in opencode ausführen.

Tipp: Sie sollten die AGENTS.md Datei Ihres Projekts in Git committen.

Dies wird Ihr Projekt und alle seine Inhalte scannen, um zu verstehen, worum es in dem Projekt geht, und eine AGENTS.md Datei damit generieren. Dies hilft opencode, besser im Projekt zu navigieren.

Wenn Sie bereits eine AGENTS.md Datei haben, wird versucht, diese zu ergänzen.


Beispiel

Sie können diese Datei auch einfach manuell erstellen. Hier ist ein Beispiel für einige Dinge, die Sie in eine AGENTS.md Datei einfügen können.

AGENTS.md

Wir fügen hier projektspezifische Anweisungen hinzu und diese werden mit Ihrem Team geteilt.


Typen

opencode unterstützt auch das Lesen der AGENTS.md Datei von mehreren Standorten. Und dies dient verschiedenen Zwecken.

Projekt

Platzieren Sie eine AGENTS.md in Ihrem Projektstammverzeichnis für projektspezifische Regeln. Diese gelten nur, wenn Sie in diesem Verzeichnis oder seinen Unterverzeichnissen arbeiten.

Global

Sie können auch globale Regeln in einer ~/.config/opencode/AGENTS.md Datei haben. Diese wird auf alle opencode-Sitzungen angewendet.

Da diese nicht in Git committet oder mit Ihrem Team geteilt wird, empfehlen wir, diese zu verwenden, um persönliche Regeln anzugeben, denen das LLM folgen soll.

Claude Code Kompatibilität

Für Benutzer, die von Claude Code migrieren, unterstützt OpenCode die Dateikonventionen von Claude Code als Fallbacks:

  • Projektregeln: CLAUDE.md in Ihrem Projektverzeichnis (wird verwendet, wenn keine AGENTS.md existiert)
  • Globale Regeln: ~/.claude/CLAUDE.md (wird verwendet, wenn keine ~/.config/opencode/AGENTS.md existiert)
  • Skills: ~/.claude/skills/ — siehe Agent Skills für Details

Um die Claude Code Kompatibilität zu deaktivieren, setzen Sie eine dieser Umgebungsvariablen:

Terminal window

Priorität

Wenn opencode startet, sucht es nach Regeldateien in dieser Reihenfolge:

  • Lokale Dateien durch Traversieren vom aktuellen Verzeichnis nach oben (AGENTS.md, CLAUDE.md)
  • Globale Datei unter ~/.config/opencode/AGENTS.md
  • Claude Code Datei unter ~/.claude/CLAUDE.md (sofern nicht deaktiviert)

Die erste übereinstimmende Datei gewinnt in jeder Kategorie. Wenn Sie beispielsweise sowohl AGENTS.md als auch CLAUDE.md haben, wird nur AGENTS.md verwendet. Ebenso hat ~/.config/opencode/AGENTS.md Vorrang vor ~/.claude/CLAUDE.md.


Benutzerdefinierte Anweisungen

Sie können benutzerdefinierte Anweisungsdateien in Ihrer opencode.json oder der globalen ~/.config/opencode/opencode.json angeben. Dies ermöglicht es Ihnen und Ihrem Team, bestehende Regeln wiederzuverwenden, anstatt sie in AGENTS.md duplizieren zu müssen.

Beispiel:

opencode.json

Sie können auch Remote-URLs verwenden, um Anweisungen aus dem Web zu laden.

opencode.json

Remote-Anweisungen werden mit einem Timeout von 5 Sekunden abgerufen.

Alle Anweisungsdateien werden mit Ihren AGENTS.md Dateien kombiniert.


Externe Dateien referenzieren

Während opencode Dateireferenzen in AGENTS.md nicht automatisch parst, können Sie ähnliche Funktionalität auf zwei Arten erreichen:

Verwendung von opencode.json

Der empfohlene Ansatz ist die Verwendung des instructions Feldes in opencode.json:

opencode.json

Manuelle Anweisungen in AGENTS.md

Sie können opencode beibringen, externe Dateien zu lesen, indem Sie explizite Anweisungen in Ihrer AGENTS.md bereitstellen. Hier ist ein praktisches Beispiel:

AGENTS.md

Dieser Ansatz ermöglicht es Ihnen:

  • Modulare, wiederverwendbare Regeldateien zu erstellen
  • Regeln über Projekte hinweg via Symlinks oder Git-Submodule zu teilen
  • AGENTS.md prägnant zu halten, während detaillierte Richtlinien referenziert werden
  • Sicherzustellen, dass opencode Dateien nur bei Bedarf für die spezifische Aufgabe lädt

Tipp: Für Monorepos oder Projekte mit gemeinsamen Standards ist die Verwendung von opencode.json mit Glob-Mustern (wie packages/*/AGENTS.md) wartbarer als manuelle Anweisungen.