Repolode
Submit
spinualexandru

spinualexandru/create-opencode-desktop-plugin

A scaffolding CLI that generates a starter package for building GUI plugins for OpenCode Desktop.

View on GitHub
Stars
1
Forks
0
Open issues
0
Last commit
4 days ago

What is it?

create-opencode-desktop-plugin is a scaffolding tool that generates a ready-to-build plugin package for OpenCode Desktop, using the experimental GUI plugin SDK (@opencode/plugin/gui). Running one command with bun, npm or npx creates a project with a side panel, commands, a settings page backed by a global store, injected CSS and i18n already wired up.

The generated project can optionally include a server part that registers an RPC the panel calls, and a main-process part with an IPC bridge and a native Help menu item. Flags such as --no-server and --no-main let you skip either part. The output is a CommonJS bundle built with the SDK's Vite preset, and it ships with a watch-mode build and a TypeScript typecheck.

After scaffolding, you run the dev build and register the plugin directory in the global OpenCode configuration, then restart the desktop app once. Each later rebuild reloads the plugin.

Key features

  • 01Generates a plugin package with a side panel, commands and a titlebar pill.
  • 02Includes a settings page backed by a global store and i18n support.
  • 03Optional server-side RPC that the panel can call.
  • 04Optional Electron main-process IPC bridge and native Help menu item.
  • 05Watch-mode Vite build and TypeScript typecheck included.

Use cases

  • Starting a new OpenCode Desktop GUI plugin without setting up the build tooling by hand.
  • Learning how the experimental GUI plugin SDK wires panels, RPC and IPC together.
  • Creating a plugin that only needs a panel, by skipping the server and main-process parts.

Quick start

  1. 1

    Scaffold a new plugin project

    bun create opencode-desktop-plugin my-plugin
  2. 2

    Enter the project and start development mode

    cd my-plugin bun run dev
  3. 3

    Add the plugin directory to the global ~/.config/opencode/opencode.jsonc, then restart OpenCode Desktop

Things to know

  • It builds on the experimental GUI plugin SDK, which may change.
  • It requires OpenCode Desktop to run the plugin.

In collections

Desktop GUI apps & toolkits

Topics

#opencode#scaffolding#plugin-template#typescript#vite#electron#desktop-app#developer-tools

FAQ

What is create-opencode-desktop-plugin?
A scaffolding CLI that generates a starter package for building GUI plugins for OpenCode Desktop. create-opencode-desktop-plugin is a scaffolding tool that generates a ready-to-build plugin package for OpenCode Desktop, using the experimental GUI plugin SDK (@opencode/plugin/gui). Running one command with bun, npm or npx creates a project with a side panel, commands, a settings page backed by a global store, injected CSS and i18n already wired up.
Is create-opencode-desktop-plugin free to use? What license does it have?
create-opencode-desktop-plugin is open source under the MIT license. Check the license terms before using it in commercial products.
Is create-opencode-desktop-plugin still maintained?
Actively maintained. The last commit to create-opencode-desktop-plugin was on Nov 3, 2026.
What can I use create-opencode-desktop-plugin for?
Starting a new OpenCode Desktop GUI plugin without setting up the build tooling by hand. Learning how the experimental GUI plugin SDK wires panels, RPC and IPC together. Creating a plugin that only needs a panel, by skipping the server and main-process parts.
How do I install create-opencode-desktop-plugin?
Scaffold a new plugin project: bun create opencode-desktop-plugin my-plugin Enter the project and start development mode: cd my-plugin bun run dev Add the plugin directory to the global ~/.config/opencode/opencode.jsonc, then restart OpenCode Desktop
Where can I get create-opencode-desktop-plugin?
The source code and installation instructions are on GitHub: https://github.com/spinualexandru/create-opencode-desktop-plugin

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects