rules.mdx 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. ---
  2. title: Regole
  3. description: Imposta istruzioni personalizzate per opencode.
  4. ---
  5. Puoi fornire istruzioni personalizzate a opencode creando un file `AGENTS.md`. E' simile alle regole di Cursor. Contiene istruzioni che verranno incluse nel contesto dell'LLM per personalizzarne il comportamento per il tuo progetto.
  6. ---
  7. ## Inizializza
  8. Per creare un nuovo file `AGENTS.md`, puoi eseguire il comando `/init` in opencode.
  9. :::tip
  10. Dovresti committare il file `AGENTS.md` del progetto in Git.
  11. :::
  12. Questo scansiona il progetto e tutti i suoi contenuti per capire di cosa si tratta e generare un file `AGENTS.md`. Questo aiuta opencode a orientarsi meglio nel progetto.
  13. Se hai gia' un file `AGENTS.md` esistente, cerchera' di aggiungervi contenuti.
  14. ---
  15. ## Esempio
  16. Puoi anche creare questo file manualmente. Ecco un esempio di alcune cose che puoi inserire in un file `AGENTS.md`.
  17. ```markdown title="AGENTS.md"
  18. # SST v3 Monorepo Project
  19. This is an SST v3 monorepo with TypeScript. The project uses bun workspaces for package management.
  20. ## Project Structure
  21. - `packages/` - Contains all workspace packages (functions, core, web, etc.)
  22. - `infra/` - Infrastructure definitions split by service (storage.ts, api.ts, web.ts)
  23. - `sst.config.ts` - Main SST configuration with dynamic imports
  24. ## Code Standards
  25. - Use TypeScript with strict mode enabled
  26. - Shared code goes in `packages/core/` with proper exports configuration
  27. - Functions go in `packages/functions/`
  28. - Infrastructure should be split into logical files in `infra/`
  29. ## Monorepo Conventions
  30. - Import shared modules using workspace names: `@my-app/core/example`
  31. ```
  32. Qui stiamo aggiungendo istruzioni specifiche del progetto e saranno condivise con il tuo team.
  33. ---
  34. ## Tipi
  35. opencode supporta anche la lettura del file `AGENTS.md` da piu' posizioni, e questo serve a scopi diversi.
  36. ### Progetto
  37. Metti un `AGENTS.md` nella root del progetto per regole specifiche del progetto. Si applicano solo quando stai lavorando in questa directory o nelle sue sottodirectory.
  38. ### Globale
  39. Puoi anche avere regole globali in un file `~/.config/opencode/AGENTS.md`. Queste si applicano a tutte le sessioni di opencode.
  40. Dato che questo non viene committato in Git o condiviso con il team, consigliamo di usarlo per specificare regole personali che l'LLM deve seguire.
  41. ### Compatibilita Claude Code
  42. Per gli utenti che migrano da Claude Code, OpenCode supporta come fallback le convenzioni di file di Claude Code:
  43. - **Regole di progetto**: `CLAUDE.md` nella directory del progetto (usato se non esiste `AGENTS.md`)
  44. - **Regole globali**: `~/.claude/CLAUDE.md` (usato se non esiste `~/.config/opencode/AGENTS.md`)
  45. - **Skill**: `~/.claude/skills/` — vedi [Skill agente](/docs/skills/) per i dettagli
  46. Per disabilitare la compatibilita' con Claude Code, imposta una di queste variabili d'ambiente:
  47. ```bash
  48. export OPENCODE_DISABLE_CLAUDE_CODE=1 # Disable all .claude support
  49. export OPENCODE_DISABLE_CLAUDE_CODE_PROMPT=1 # Disable only ~/.claude/CLAUDE.md
  50. export OPENCODE_DISABLE_CLAUDE_CODE_SKILLS=1 # Disable only .claude/skills
  51. ```
  52. ---
  53. ## Priorita
  54. Quando opencode si avvia, cerca i file di regole in questo ordine:
  55. 1. **File locali** risalendo dalla directory corrente (`AGENTS.md`, `CLAUDE.md`)
  56. 2. **File globale** in `~/.config/opencode/AGENTS.md`
  57. 3. **File Claude Code** in `~/.claude/CLAUDE.md` (se non disabilitato)
  58. In ogni categoria vince il primo file corrispondente. Per esempio, se hai sia `AGENTS.md` sia `CLAUDE.md`, viene usato solo `AGENTS.md`. Allo stesso modo, `~/.config/opencode/AGENTS.md` ha priorita' su `~/.claude/CLAUDE.md`.
  59. ---
  60. ## Istruzioni personalizzate
  61. Puoi specificare file di istruzioni personalizzati nel tuo `opencode.json` o nel globale `~/.config/opencode/opencode.json`. Questo permette a te e al tuo team di riusare regole esistenti invece di doverle duplicare in AGENTS.md.
  62. Esempio:
  63. ```json title="opencode.json"
  64. {
  65. "$schema": "https://opencode.ai/config.json",
  66. "instructions": ["CONTRIBUTING.md", "docs/guidelines.md", ".cursor/rules/*.md"]
  67. }
  68. ```
  69. Puoi anche usare URL remoti per caricare istruzioni dal web.
  70. ```json title="opencode.json"
  71. {
  72. "$schema": "https://opencode.ai/config.json",
  73. "instructions": ["https://raw.githubusercontent.com/my-org/shared-rules/main/style.md"]
  74. }
  75. ```
  76. Le istruzioni remote vengono recuperate con un timeout di 5 secondi.
  77. Tutti i file di istruzioni vengono combinati con i tuoi file `AGENTS.md`.
  78. ---
  79. ## Riferisci file esterni
  80. Anche se opencode non interpreta automaticamente i riferimenti a file in `AGENTS.md`, puoi ottenere una funzionalita' simile in due modi:
  81. ### Usa opencode.json
  82. L'approccio consigliato e' usare il campo `instructions` in `opencode.json`:
  83. ```json title="opencode.json"
  84. {
  85. "$schema": "https://opencode.ai/config.json",
  86. "instructions": ["docs/development-standards.md", "test/testing-guidelines.md", "packages/*/AGENTS.md"]
  87. }
  88. ```
  89. ### Istruzioni manuali in AGENTS.md
  90. Puoi insegnare a opencode a leggere file esterni fornendo istruzioni esplicite nel tuo `AGENTS.md`. Ecco un esempio pratico:
  91. ```markdown title="AGENTS.md"
  92. # TypeScript Project Rules
  93. ## External File Loading
  94. 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.
  95. Instructions:
  96. - Do NOT preemptively load all references - use lazy loading based on actual need
  97. - When loaded, treat content as mandatory instructions that override defaults
  98. - Follow references recursively when needed
  99. ## Development Guidelines
  100. For TypeScript code style and best practices: @docs/typescript-guidelines.md
  101. For React component architecture and hooks patterns: @docs/react-patterns.md
  102. For REST API design and error handling: @docs/api-standards.md
  103. For testing strategies and coverage requirements: @test/testing-guidelines.md
  104. ## General Guidelines
  105. Read the following file immediately as it's relevant to all workflows: @rules/general-guidelines.md.
  106. ```
  107. Questo approccio ti permette di:
  108. - Crea file di regole modulari e riutilizzabili
  109. - Condividi regole tra progetti con symlink o submodule Git
  110. - Mantieni AGENTS.md conciso riferendoti a linee guida dettagliate
  111. - Assicurati che opencode carichi file solo quando servono per il task specifico
  112. :::tip
  113. Per monorepo o progetti con standard condivisi, usare `opencode.json` con pattern glob (come `packages/*/AGENTS.md`) e' piu' manutenibile rispetto alle istruzioni manuali.
  114. :::