Skip to content

# opensoul plugins

管理 Gateway 网关插件/扩展(进程内加载)。

相关内容:

# 命令

bash
opensoul plugins list
opensoul plugins info <id>
opensoul plugins enable <id>
opensoul plugins disable <id>
opensoul plugins doctor
opensoul plugins update <id>
opensoul plugins update --all

内置插件随 OpenSoul 一起发布,但默认禁用。使用 plugins enable 来激活它们。

所有插件必须提供 opensoul.plugin.json 文件,其中包含内联 JSON Schema(configSchema,即使为空)。缺少或无效的清单或模式会阻止插件加载并导致配置验证失败。

# 安装

bash
opensoul plugins install <path-or-spec>

安全提示:将插件安装视为运行代码。优先使用固定版本。

支持的归档格式:.zip.tgz.tar.gz.tar

使用 --link 避免复制本地目录(添加到 plugins.load.paths):

bash
opensoul plugins install -l ./my-plugin

# 更新

bash
opensoul plugins update <id>
opensoul plugins update --all
opensoul plugins update <id> --dry-run

更新仅适用于从 npm 安装的插件(在 plugins.installs 中跟踪)。

Released under the MIT License.