42 lines
1.1 KiB
Markdown
42 lines
1.1 KiB
Markdown
---
|
|
name: plugin-creator
|
|
description: Create OpenCode plugins and know where to load them.
|
|
---
|
|
|
|
## Quick Usage (Already Configured)
|
|
|
|
### Where plugins live
|
|
- Project plugins: `.opencode/plugins/*.js` or `.opencode/plugins/*.ts`
|
|
- Global plugins: `~/.config/opencode/plugins/*.js` or `.ts`
|
|
|
|
### Load from npm
|
|
Add npm plugin packages in `opencode.json`:
|
|
```json
|
|
{
|
|
"$schema": "https://opencode.ai/config.json",
|
|
"plugin": ["opencode-helicone-session", "opencode-wakatime"]
|
|
}
|
|
```
|
|
|
|
## Minimal plugin template
|
|
|
|
```ts
|
|
export const MyPlugin = async ({ project, client, $, directory, worktree }) => {
|
|
return {
|
|
// Hook implementations go here
|
|
}
|
|
}
|
|
```
|
|
|
|
## Notes from OpenCode docs
|
|
|
|
- Plugins are JS/TS modules exporting one or more plugin functions.
|
|
- Local plugins are loaded directly from the plugin directory.
|
|
- NPM plugins are installed via Bun at startup and cached in `~/.cache/opencode/node_modules/`.
|
|
- Load order: global config → project config → global plugins → project plugins.
|
|
|
|
## Reference
|
|
|
|
Follow the official OpenCode plugin docs: https://opencode.ai/docs/plugins/
|
|
Use the docs as the escape hatch when unsure.
|