SDK 与脚手架目前通过源码仓库使用,npm 发布暂缓。文档中的 registry 安装命令用于后续正式版本;当前预览请使用「第一个插件」中的源码流程。

插件文档

安装并启用插件

最终用户如何从文件或 URL 安装安装包、审阅、按工作区启用,以及如何移除。

本页面向使用插件的人。不需要开发工具:一个插件包就是一个 .ghostboard-plugin(或 .zip)归档。

安装插件包

  1. 打开 设置 → 插件。
  2. 在 安装插件包 下,点击 选择插件包… 选本地归档,或粘贴 插件包 URL 后点击 审阅链接。URL 必须是公共 https:// 地址;回环、私网目标(包括解析或重定向后的)、非 ZIP 响应与超大下载都会被拒绝。
  3. GhostBoard 在不执行任何代码的情况下检查归档,并显示 审阅插件包:名称、ID、版本、作者、声明的 capabilities、签名状态、更新来源与 SHA-256 摘要。
  4. 点击 安装插件包。安装对整个应用生效,但尚未在任何工作区启用。

安装过程不会运行 npm install、构建脚本或插件本身。

在工作区启用

插件按工作区运行。在 已安装插件 中选择 为此工作区启用,阅读高信任说明后点击 我信任此插件,启用。已启用的插件在 GhostBoard 窗口内运行,可完全访问工作区数据、本地文件、网络与页面。声明的 capabilities 只是信息,不是限制。

切换到另一个工作区不会带走启用状态;每个工作区独立记录自己的选择,插件的持久数据也按工作区分开保存。

停用、更新、回退

  • 在此工作区停用 会移除该工作区内此插件的命令、面板、订阅与任务。其持久数据、画布卡片与导入的 Notes 保留。
  • 检查更新 适用于声明了更新来源的已签名插件。GhostBoard 下载 release 文档,选出与你的 GhostBoard 版本兼容的最新版本,校验 SHA-256 与作者签名,然后显示与全新安装相同的审阅步骤。用不同密钥签名或指向不同来源的更新会被拒绝并提示“作者密钥已变更”。
  • 将代码回退到 … 重新安装上一个版本经过校验的文件。插件保持停用,直到你再次审阅并启用。
  • 恢复 N 份迁移前备份 在插件的画布卡片数据被迁移到更高 dataVersion 后出现。恢复会用备份替换已迁移的卡片数据,并保持插件停用。

安全模式

如果 GhostBoard 在启用插件的情况下未能完成启动,下一次启动会自动跳过第三方代码,并在设置 → 插件显示 插件安全模式已启用。也可以用 --safe-mode 参数或 GHOSTBOARD_SAFE_MODE=1 主动请求。安全模式下仍可停用或移除插件、恢复数据;处理完后选择 下次启动尝试启用插件。

卸载

移除插件只删除代码。自定义画布类型创建的卡片通过已保存的摘要保持可读,插件键值数据保留,导入器创建的 Notes 就是普通 Notes。永久删除数据是单独的显式操作,会显示影响范围。