rules.mdx 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. ---
  2. title: Regeln
  3. description: Lege eigene Anweisungen fuer opencode fest.
  4. ---
  5. Du kannst opencode ueber eine `AGENTS.md`-Datei mit eigenen Anweisungen steuern.
  6. Das ist aehnlich zu den Regeln in Cursor und wird direkt in den LLM-Kontext geladen.
  7. ---
  8. ## Initialisierung
  9. Um eine neue `AGENTS.md` zu erstellen, fuehre in opencode den Befehl `/init` aus.
  10. :::tip
  11. Du solltest die `AGENTS.md` deines Projekts in Git committen.
  12. :::
  13. Der Befehl scannt dein Projekt und erzeugt daraus eine passende `AGENTS.md`.
  14. So kann opencode sich in deinem Code besser orientieren.
  15. Wenn bereits eine `AGENTS.md` existiert, versucht opencode sie zu erweitern.
  16. ---
  17. ## Beispiel
  18. Du kannst die Datei auch manuell anlegen.
  19. Hier ist ein Beispiel, was in einer `AGENTS.md` stehen kann.
  20. ```markdown title="AGENTS.md"
  21. # SST v3 Monorepo Project
  22. This is an SST v3 monorepo with TypeScript. The project uses bun workspaces for package management.
  23. ## Project Structure
  24. - `packages/` - Contains all workspace packages (functions, core, web, etc.)
  25. - `infra/` - Infrastructure definitions split by service (storage.ts, api.ts, web.ts)
  26. - `sst.config.ts` - Main SST configuration with dynamic imports
  27. ## Code Standards
  28. - Use TypeScript with strict mode enabled
  29. - Shared code goes in `packages/core/` with proper exports configuration
  30. - Functions go in `packages/functions/`
  31. - Infrastructure should be split into logical files in `infra/`
  32. ## Monorepo Conventions
  33. - Import shared modules using workspace names: `@my-app/core/example`
  34. ```
  35. Hier hinterlegst du projektspezifische Regeln, die dein Team gemeinsam nutzt.
  36. ---
  37. ## Typen
  38. opencode kann `AGENTS.md` aus mehreren Orten lesen.
  39. Die Orte haben unterschiedliche Zwecke.
  40. ### Projekt
  41. Lege eine `AGENTS.md` im Projekt-Root ab, um projektspezifische Regeln zu definieren.
  42. Diese gelten nur in diesem Verzeichnis und seinen Unterordnern.
  43. ### Global
  44. Du kannst auch globale Regeln in `~/.config/opencode/AGENTS.md` speichern.
  45. Diese gelten in allen opencode-Sitzungen.
  46. Da diese Datei nicht in Git landet und nicht mit dem Team geteilt wird, eignet sie sich fuer persoenliche Regeln.
  47. ### Claude Code-Kompatibilität
  48. Wenn du von Claude Code kommst, unterstuetzt OpenCode dessen Dateikonventionen als Fallback:
  49. - **Projektregeln**: `CLAUDE.md` im Projekt (wenn keine `AGENTS.md` existiert)
  50. - **Globale Regeln**: `~/.claude/CLAUDE.md` (wenn keine `~/.config/opencode/AGENTS.md` existiert)
  51. - **Skills**: `~/.claude/skills/` - siehe [Agent Skills](/docs/skills/) fuer Details
  52. Um die Claude-Code-Kompatibilitaet zu deaktivieren, setze eine dieser Umgebungsvariablen:
  53. ```bash
  54. export OPENCODE_DISABLE_CLAUDE_CODE=1 # Disable all .claude support
  55. export OPENCODE_DISABLE_CLAUDE_CODE_PROMPT=1 # Disable only ~/.claude/CLAUDE.md
  56. export OPENCODE_DISABLE_CLAUDE_CODE_SKILLS=1 # Disable only .claude/skills
  57. ```
  58. ---
  59. ## Rangfolge
  60. Beim Start sucht opencode in dieser Reihenfolge nach Regeldateien:
  61. 1. **Lokale Dateien** beim Hochlaufen ab dem aktuellen Verzeichnis (`AGENTS.md`, `CLAUDE.md`)
  62. 2. **Globale Datei** unter `~/.config/opencode/AGENTS.md`
  63. 3. **Claude-Code-Datei** unter `~/.claude/CLAUDE.md` (falls nicht deaktiviert)
  64. Pro Kategorie gewinnt die zuerst passende Datei.
  65. Wenn sowohl `AGENTS.md` als auch `CLAUDE.md` existieren, wird nur `AGENTS.md` verwendet.
  66. ---
  67. ## Eigene Anweisungen
  68. Du kannst zusaetzliche Anweisungsdateien in deiner `opencode.json` oder in `~/.config/opencode/opencode.json` angeben.
  69. So kann dein Team bestehende Regeln wiederverwenden, statt Inhalte in `AGENTS.md` zu duplizieren.
  70. Beispiel:
  71. ```json title="opencode.json"
  72. {
  73. "$schema": "https://opencode.ai/config.json",
  74. "instructions": ["CONTRIBUTING.md", "docs/guidelines.md", ".cursor/rules/*.md"]
  75. }
  76. ```
  77. Du kannst auch Remote-URLs nutzen, um Regeln aus dem Web zu laden.
  78. ```json title="opencode.json"
  79. {
  80. "$schema": "https://opencode.ai/config.json",
  81. "instructions": ["https://raw.githubusercontent.com/my-org/shared-rules/main/style.md"]
  82. }
  83. ```
  84. Remote-Anweisungen werden mit 5 Sekunden Timeout geladen.
  85. Alle Anweisungsdateien werden mit deinen `AGENTS.md`-Dateien kombiniert.
  86. ---
  87. ## Externe Dateien referenzieren
  88. opencode parst Datei-Referenzen in `AGENTS.md` nicht automatisch.
  89. Du erreichst aehnliches Verhalten auf zwei Wegen.
  90. ### Mit opencode.json
  91. Empfohlen ist das `instructions`-Feld in der `opencode.json`:
  92. ```json title="opencode.json"
  93. {
  94. "$schema": "https://opencode.ai/config.json",
  95. "instructions": ["docs/development-standards.md", "test/testing-guidelines.md", "packages/*/AGENTS.md"]
  96. }
  97. ```
  98. ### Manuelle Anweisungen in AGENTS.md
  99. Du kannst opencode explizit anweisen, externe Dateien zu lesen.
  100. Hier ein praxisnahes Beispiel:
  101. ```markdown title="AGENTS.md"
  102. # TypeScript Project Rules
  103. ## External File Loading
  104. CRITICAL: When you encounter a file reference (e.g., @rules/general.md), use your Read tool to load it on a need-to-know basis. They're relevant to the SPECIFIC task at hand.
  105. Instructions:
  106. - Do NOT preemptively load all references - use lazy loading based on actual need
  107. - When loaded, treat content as mandatory instructions that override defaults
  108. - Follow references recursively when needed
  109. ## Development Guidelines
  110. For TypeScript code style and best practices: @docs/typescript-guidelines.md
  111. For React component architecture and hooks patterns: @docs/react-patterns.md
  112. For REST API design and error handling: @docs/api-standards.md
  113. For testing strategies and coverage requirements: @test/testing-guidelines.md
  114. ## General Guidelines
  115. Read the following file immediately as it's relevant to all workflows: @rules/general-guidelines.md.
  116. ```
  117. Damit kannst du:
  118. - Modulare, wiederverwendbare Regeldateien erstellen
  119. - Regeln projektuebergreifend per Symlink oder Git-Submodule teilen
  120. - `AGENTS.md` kurz halten und auf Detailregeln verweisen
  121. - Sicherstellen, dass Dateien nur bei Bedarf geladen werden
  122. :::tip
  123. Fuer Monorepos oder gemeinsame Standards ist `opencode.json` mit Glob-Mustern (z. B. `packages/*/AGENTS.md`) oft wartbarer als manuelle Anweisungen.
  124. :::