{{description}}
An OpenCode plugin created from the opencode-plugin-template
- 🏗️ TypeScript-based plugin architecture
- 🔧 Mise task runner integration
- 📦 Bun/npm build tooling
- ✨ ESLint + Prettier formatting
- 🧪 Vitest testing setup
- 🚀 GitHub Actions CI/CD
- 📝 Release automation with release-please
-
Clone this template:
cp -r opencode-plugin-template your-plugin-name cd your-plugin-name -
Update package.json:
- Change
nameto your plugin name - Update
description - Update
repository.url
- Change
-
Install dependencies:
bun install
-
Implement your plugin in
src/index.ts:import type { Plugin } from '@opencode-ai/plugin'; export const YourPlugin: Plugin = async (ctx) => { return { tool: { // Your plugin tools here }, }; };
-
Test your plugin:
mise run test
mise run build- Build the pluginmise run test- Run testsmise run lint- Lint codemise run lint:fix- Fix linting issuesmise run format- Format code with Prettier
Create or edit ~/.config/opencode/config.json:
{
"plugins": ["{{pluginName}}"]
}{{authorName}} <{{authorEmail}}>
{{repositoryUrl}}
Contributions are welcome! Please file issues or submit pull requests on the GitHub repository.
MIT License. See the LICENSE file for details.