summaryrefslogtreecommitdiffhomepage
path: root/packages/web/src/content/docs/bs/plugins.mdx
blob: 7e046cb83dfd1e9211b3fe89606839e163442344 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
---
title: Dodaci
description: Napišite vlastite dodatke za proširenje OpenCode.
---

Dodaci vam omogućavaju da proširite OpenCode spajanjem na različite događaje i prilagođavanjem ponašanja. Možete kreirati dodatke za dodavanje novih funkcija, integraciju sa eksternim uslugama ili izmenu zadanog ponašanja OpenCode.
Za primjere, pogledajte [plugins](/docs/ecosystem#plugins) kreirane od strane zajednice.

---

## Korištenje dodatka

Postoje dva načina za učitavanje dodataka.

### Iz lokalnih datoteka

Postavite JavaScript ili TypeScript datoteke u direktorij dodataka.

- `.opencode/plugins/` - Dodaci na nivou projekta
- `~/.config/opencode/plugins/` - Globalni dodaci
  Datoteke u ovim direktorijumima se automatski učitavaju pri pokretanju.

---

### Iz npm-a

Navedite npm pakete u vašoj konfiguracijskoj datoteci.

```json title="opencode.json"
{
  "$schema": "https://opencode.ai/config.json",
  "plugin": ["opencode-helicone-session", "opencode-wakatime", "@my-org/custom-plugin"]
}
```

Podržani su i regularni i npm paketi sa opsegom.
Pregledajte dostupne dodatke u [ecosystem](/docs/ecosystem#plugins).

---

### Kako se instaliraju dodaci

**npm dodaci** se instaliraju automatski pomoću Bun pri pokretanju. Paketi i njihove zavisnosti su keširani u `~/.cache/opencode/node_modules/`.
**Lokalni dodaci** se učitavaju direktno iz direktorija dodataka. Da biste koristili vanjske pakete, morate kreirati `package.json` unutar svog konfiguracijskog direktorija (pogledajte [Zavisnosti](#dependencies)) ili objaviti dodatak na npm i [dodati ga u svoju konfiguraciju](/docs/config#plugins).

---

### Redoslijed učitavanja

Dodaci se učitavaju iz svih izvora i svi zakačnjaci rade u nizu. Redoslijed učitavanja je:

1. Globalna konfiguracija (`~/.config/opencode/opencode.json`)
2. Konfiguracija projekta (`opencode.json`)
3. Globalni direktorij dodataka (`~/.config/opencode/plugins/`)
4. Direktorij dodataka projekta (`.opencode/plugins/`)
   Duplicirani npm paketi sa istim imenom i verzijom se učitavaju jednom. Međutim, lokalni dodatak i npm dodatak sa sličnim nazivima se učitavaju odvojeno.

---

## Kreiranje dodatka

Dodatak je **JavaScript/TypeScript modul** koji izvozi jedan ili više dodataka
funkcije. Svaka funkcija prima objekt konteksta i vraća hooks objekt.

---

### Zavisnosti

Lokalni dodaci i prilagođeni alati mogu koristiti vanjske npm pakete. Dodajte `package.json` u svoj konfiguracijski direktorij sa zavisnostima koje su vam potrebne.

```json title=".opencode/package.json"
{
  "dependencies": {
    "shescape": "^2.1.0"
  }
}
```

OpenCode pokreće `bun install` pri pokretanju da ih instalira. Vaši dodaci i alati ih zatim mogu uvesti.

```ts title=".opencode/plugins/my-plugin.ts"
import { escape } from "shescape"

export const MyPlugin = async (ctx) => {
  return {
    "tool.execute.before": async (input, output) => {
      if (input.tool === "bash") {
        output.args.command = escape(output.args.command)
      }
    },
  }
}
```

---

### Osnovna struktura

```js title=".opencode/plugins/example.js"
export const MyPlugin = async ({ project, client, $, directory, worktree }) => {
  console.log("Plugin initialized!")

  return {
    // Hook implementations go here
  }
}
```

Funkcija dodatka prima:

- `project`: Trenutne informacije o projektu.
- `directory`: Trenutni radni direktorij.
- `worktree`: Putanja git radnog stabla.
- `client`: Opencode SDK klijent za interakciju sa AI.
- `$`: Bun's [shell API](https://bun.com/docs/runtime/shell) za izvršavanje naredbi.

---

### Podrška za TypeScript

Za TypeScript dodatke, možete uvesti tipove iz paketa dodataka:

```ts title="my-plugin.ts" {1}
import type { Plugin } from "@opencode-ai/plugin"

export const MyPlugin: Plugin = async ({ project, client, $, directory, worktree }) => {
  return {
    // Type-safe hook implementations
  }
}
```

---

### Događaji

Dodaci se mogu pretplatiti na događaje kao što je prikazano ispod u odjeljku Primjeri. Evo liste različitih dostupnih događaja.

#### Komandni događaji

- `command.executed`

#### Događaji datoteka

- `file.edited`
- `file.watcher.updated`

#### Instalacijski događaji

- `installation.updated`

#### LSP događaji

- `lsp.client.diagnostics`
- `lsp.updated`

#### Događaji poruka

- `message.part.removed`
- `message.part.updated`
- `message.removed`
- `message.updated`

#### Događaji dozvola

- `permission.asked`
- `permission.replied`

#### Serverski događaji

- `server.connected`

#### Događaji sesije

- `session.created`
- `session.compacted`
- `session.deleted`
- `session.diff`
- `session.error`
- `session.idle`
- `session.status`
- `session.updated`

#### Todo događaji

- `todo.updated`

#### Shell događaji

- `shell.env`

#### Događaji alata

- `tool.execute.after`
- `tool.execute.before`

#### TUI događaji

- `tui.prompt.append`
- `tui.command.execute`
- `tui.toast.show`

---

## Primjeri

Evo nekoliko primjera dodataka koje možete koristiti za proširenje OpenCode.

### Slanje obavještenja

Pošaljite obavještenja kada se dogode određeni događaji:

```js title=".opencode/plugins/notification.js"
export const NotificationPlugin = async ({ project, client, $, directory, worktree }) => {
  return {
    event: async ({ event }) => {
      // Send notification on session completion
      if (event.type === "session.idle") {
        await $`osascript -e 'display notification "Session completed!" with title "opencode"'`
      }
    },
  }
}
```

Koristimo `osascript` za pokretanje AppleScript-a na macOS-u. Ovdje ga koristimo za slanje obavještenja.
:::note
Ako alat dodatka koristi isto ime kao ugrađeni alat, alat dodatka ima prednost.
:::

---

### .env zaštita

Spriječite opencode da čita `.env` fajlove:

```javascript title=".opencode/plugins/env-protection.js"
export const EnvProtection = async ({ project, client, $, directory, worktree }) => {
  return {
    "tool.execute.before": async (input, output) => {
      if (input.tool === "read" && output.args.filePath.includes(".env")) {
        throw new Error("Do not read .env files")
      }
    },
  }
}
```

---

### Ubacivanje varijabli okruženja

Ubacite varijable okruženja u sva izvršavanja ljuske (AI alati i korisnički terminali):

```javascript title=".opencode/plugins/inject-env.js"
export const InjectEnvPlugin = async () => {
  return {
    "shell.env": async (input, output) => {
      output.env.MY_API_KEY = "secret"
      output.env.PROJECT_ROOT = input.cwd
    },
  }
}
```

---

### Prilagođeni alati

Dodaci također mogu dodati prilagođene alate u opencode:

```ts title=".opencode/plugins/custom-tools.ts"
import { type Plugin, tool } from "@opencode-ai/plugin"

export const CustomToolsPlugin: Plugin = async (ctx) => {
  return {
    tool: {
      mytool: tool({
        description: "This is a custom tool",
        args: {
          foo: tool.schema.string(),
        },
        async execute(args, context) {
          const { directory, worktree } = context
          return `Hello ${args.foo} from ${directory} (worktree: ${worktree})`
        },
      }),
    },
  }
}
```

Pomoćnik `tool` kreira prilagođeni alat koji opencode može pozvati. Uzima funkciju Zod sheme i vraća definiciju alata sa:

- `description`: Šta alat radi
- `args`: Zod šema za argumente alata
- `execute`: Funkcija koja se pokreće kada se pozove alat
  Vaši prilagođeni alati će biti dostupni za opencode zajedno sa ugrađenim alatima.

---

### Bilježenje

Koristite `client.app.log()` umjesto `console.log` za strukturirano bilježenje:

```ts title=".opencode/plugins/my-plugin.ts"
export const MyPlugin = async ({ client }) => {
  await client.app.log({
    body: {
      service: "my-plugin",
      level: "info",
      message: "Plugin initialized",
      extra: { foo: "bar" },
    },
  })
}
```

Nivoi su: `debug`, `info`, `warn`, `error`. Pogledajte [SDK dokumentaciju](https://opencode.ai/docs/sdk) za detalje.

### Kuke za sažimanje

Prilagodite kontekst uključen kada se sesija zbije:

```ts title=".opencode/plugins/compaction.ts"
import type { Plugin } from "@opencode-ai/plugin"

export const CompactionPlugin: Plugin = async (ctx) => {
  return {
    "experimental.session.compacting": async (input, output) => {
      // Inject additional context into the compaction prompt
      output.context.push(`
## Custom Context

Include any state that should persist across compaction:
- Current task status
- Important decisions made
- Files being actively worked on
`)
    },
  }
}
```

`experimental.session.compacting` kuka se aktivira prije nego što LLM generira sažetak nastavka. Koristite ga za ubacivanje konteksta specifičnog za domenu koji bi zadani prompt za sažimanje propustio.
Također možete u potpunosti zamijeniti prompt za sabijanje postavljanjem `output.prompt`:

```ts title=".opencode/plugins/custom-compaction.ts"
import type { Plugin } from "@opencode-ai/plugin"

export const CustomCompactionPlugin: Plugin = async (ctx) => {
  return {
    "experimental.session.compacting": async (input, output) => {
      // Replace the entire compaction prompt
      output.prompt = `
You are generating a continuation prompt for a multi-agent swarm session.

Summarize:
1. The current task and its status
2. Which files are being modified and by whom
3. Any blockers or dependencies between agents
4. The next steps to complete the work

Format as a structured prompt that a new agent can use to resume work.
`
    },
  }
}
```

Kada je `output.prompt` postavljen, on u potpunosti zamjenjuje zadani prompt za sažimanje. Niz `output.context` se zanemaruje u ovom slučaju.