No description
  • TypeScript 100%
Find a file
2026-05-24 11:02:20 -06:00
docs docs: move PLUGIN_GUIDE.md to docs/, update references 2026-05-24 11:02:20 -06:00
src chore: add biome for basic code quality 2026-05-24 10:35:30 -06:00
.gitignore feat: add plugin starter kit files 2026-05-20 12:09:59 -06:00
biome.json chore: add biome for basic code quality 2026-05-24 10:35:30 -06:00
bun.lock chore: add biome for basic code quality 2026-05-24 10:35:30 -06:00
INSTRUCTIONS.md docs: move PLUGIN_GUIDE.md to docs/, update references 2026-05-24 11:02:20 -06:00
package.json chore: add biome for basic code quality 2026-05-24 10:35:30 -06:00
README.md docs: move PLUGIN_GUIDE.md to docs/, update references 2026-05-24 11:02:20 -06:00
tsconfig.build.json chore: add types build, update docs 2026-05-24 10:19:02 -06:00
tsconfig.json chore: add types build, update docs 2026-05-24 10:19:02 -06:00

OpenCode Plugin Starter Kit

A minimal bootstrap for creating OpenCode plugins. Zero code to delete — just install, name, build, and start developing.

Quick Start

1. Copy the repo

Clone or copy this repo into a new directory for your plugin:

git clone https://github.com/<your-org>/opencode-plugin-starter.git my-plugin
cd my-plugin

Or use degit for a clean copy without git history:

bunx degit <repo-url> my-plugin
cd my-plugin

2. Bootstrap

Follow the steps in INSTRUCTIONS.md to set up your plugin. You can follow them manually or paste this into an OpenCode agent and let it do the work for you:

"Read INSTRUCTIONS.md and follow each step."

3. Start developing

Once bootstrapped, edit src/index.ts to add hooks, tools, or config modifications. See docs/PLUGIN_GUIDE.md for reference on the plugin API.

What's Included

File Purpose
package.json Pre-configured with @opencode-ai/plugin, typescript, @types/bun, and a build script
tsconfig.json Bun + ESNext + bundler module resolution
src/index.ts Bare skeleton plugin — compiles and loads, does nothing
.gitignore node_modules/, dist/, .opencode/
INSTRUCTIONS.md Step-by-step bootstrap guide (deleted after setup)
docs/PLUGIN_GUIDE.md Plugin API reference (stays as documentation)

Requirements