No description
- TypeScript 100%
| docs | ||
| src | ||
| .gitignore | ||
| biome.json | ||
| bun.lock | ||
| INSTRUCTIONS.md | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
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) |