Repolode
spinualexandru

spinualexandru/create-opencode-desktop-plugin

用于快速生成 OpenCode Desktop GUI 插件项目模板的脚手架工具。

Star
1
Fork
0
未关闭 Issue
0
最近提交
4天前

这是什么?

create-opencode-desktop-plugin 是一个脚手架工具,用于为 OpenCode Desktop 生成可直接构建的插件项目,基于实验性的 GUI 插件 SDK(@opencode/plugin/gui)。使用 bun、npm 或 npx 执行一条命令,即可得到已配置好侧边面板、命令、基于全局 Store 的设置页、注入样式和国际化的项目。

生成的项目可选择包含服务端部分(注册供面板调用的 RPC)和主进程部分(提供 IPC 桥接及原生 Help 菜单项)。可通过 --no-server、--no-main 等参数跳过其中任一部分。产物为使用 SDK Vite 预设构建的 CommonJS 包,并附带监听模式构建和 TypeScript 类型检查。

脚手架生成后,运行开发构建,并在全局 OpenCode 配置中注册插件目录,重启一次桌面应用即可。之后每次重新构建都会自动重载插件。

核心功能

  • 01生成包含侧边面板、命令和标题栏按钮的插件包。
  • 02内置基于全局 Store 的设置页并支持国际化。
  • 03可选的服务端 RPC,供面板调用。
  • 04可选的 Electron 主进程 IPC 桥接及原生 Help 菜单项。
  • 05包含监听模式的 Vite 构建和 TypeScript 类型检查。

适用场景

  • 不手动搭建构建工具,快速开始一个 OpenCode Desktop GUI 插件。
  • 了解实验性 GUI 插件 SDK 如何连接面板、RPC 与 IPC。
  • 只需要面板功能时,通过跳过服务端和主进程部分来精简项目。

快速上手

  1. 1

    创建新的插件项目

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

    进入项目并启动开发模式

    cd my-plugin bun run dev
  3. 3

    将插件目录添加到全局 ~/.config/opencode/opencode.jsonc,然后重启 OpenCode Desktop

使用前须知

  • 它基于实验性的 GUI 插件 SDK,该 SDK 可能发生变化。
  • 运行该插件需要 OpenCode Desktop。

收录于专题

标签

常见问题

create-opencode-desktop-plugin 是什么?
用于快速生成 OpenCode Desktop GUI 插件项目模板的脚手架工具。 create-opencode-desktop-plugin 是一个脚手架工具,用于为 OpenCode Desktop 生成可直接构建的插件项目,基于实验性的 GUI 插件 SDK(@opencode/plugin/gui)。使用 bun、npm 或 npx 执行一条命令,即可得到已配置好侧边面板、命令、基于全局 Store 的设置页、注入样式和国际化的项目。
create-opencode-desktop-plugin 可以免费使用吗?用的什么许可证?
create-opencode-desktop-plugin 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
create-opencode-desktop-plugin 还在维护吗?
活跃维护中。create-opencode-desktop-plugin 最近一次提交是在 2026年11月3日。
create-opencode-desktop-plugin 适合用来做什么?
不手动搭建构建工具,快速开始一个 OpenCode Desktop GUI 插件。 了解实验性 GUI 插件 SDK 如何连接面板、RPC 与 IPC。 只需要面板功能时,通过跳过服务端和主进程部分来精简项目。
create-opencode-desktop-plugin 怎么安装和运行?
创建新的插件项目: bun create opencode-desktop-plugin my-plugin 进入项目并启动开发模式: cd my-plugin bun run dev 将插件目录添加到全局 ~/.config/opencode/opencode.jsonc,然后重启 OpenCode Desktop
在哪里获取 create-opencode-desktop-plugin?
源代码和安装说明在 GitHub 上:https://github.com/spinualexandru/create-opencode-desktop-plugin

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目