要求
- 具有可用
openclawCLI 的 OpenClaw 检出版本或安装 - 能够访问所选来源(ClawHub、npm 或 git 托管平台)的网络
- 该插件设置文档中指定的任何插件专用凭据、配置键或操作系统工具
- 允许为你的渠道提供服务的 Gateway 网关重新加载或重启的权限
快速开始
1
查找插件
在 ClawHub 中搜索公开插件包:ClawHub 是发现社区插件的主要入口。在上线切换期间,
普通的裸包规范仍会从 npm 安装,除非它们与某个官方插件 ID
匹配。与内置插件匹配的原始
@openclaw/* 规范会解析到
对应的内置副本。需要明确指定某个来源时,请使用显式来源前缀。2
安装插件
npm-pack: 或市场来源,在你
审查并信任其来源后,非交互式安装需要
--force。3
配置并启用插件
在 如果设置了
plugins.entries.<id>.config 下配置插件专用设置。
如果插件尚未启用,请启用它:plugins.allow,已安装插件的 ID 必须位于该列表中,
插件才能加载。openclaw plugins install 会将已安装的
ID 添加到现有 plugins.allow 列表中,并从
plugins.deny 中移除同一 ID,以便显式安装的插件在重启后加载。4
让 Gateway 网关重新加载
安装、更新或卸载插件代码需要重启 Gateway 网关。
启用配置重新加载的托管 Gateway 网关会检测到变化的
插件安装记录并自动重启。否则,请自行重启:启用/禁用操作会更新配置和冷注册表。运行时检查
仍是验证实时运行时接口最清晰的方式。
5
验证运行时注册
--runtime 验证已注册的工具、钩子、服务、Gateway 网关
方法或插件自有 CLI 命令。普通的 inspect 仅执行冷清单
和注册表检查。配置
选择安装来源
裸包规范具有特殊的兼容行为:与内置插件 ID
匹配的裸名称使用对应的内置来源;与官方外部插件 ID 匹配的裸名称
使用官方包目录;在上线切换期间,任何其他裸规范都通过 npm
安装。与内置插件匹配的原始
@openclaw/*
规范也会在回退到 npm 前解析到内置副本。若要有意安装
外部 npm 包而非内置副本,请使用 npm:@openclaw/<plugin>@<version>。
使用 clawhub:、npm:、
git: 或 npm-pack: 可确定性地选择来源。完整命令约定请参阅
openclaw plugins。
对于 npm 安装,未固定的规范和 @latest 会选择声明与
当前 OpenClaw 构建兼容的最新稳定包。如果 npm
当前的 latest 版本声明了比此构建所支持版本更新的
openclaw.compat.pluginApi 或 openclaw.install.minHostVersion,OpenClaw 会扫描
较旧的稳定版本,并安装其中最新的兼容版本。确切版本
以及 @beta 等显式渠道标签会固定到所选包,
不兼容时安装将失败。
操作员安装策略
配置security.installPolicy,以便在插件安装或更新继续之前
运行受信任的本地策略命令。该策略会接收元数据以及
暂存的源路径,并可允许或阻止安装。它同时覆盖 CLI
和由 Gateway 网关支持的安装/更新路径。插件 before_install 钩子会在
之后运行,并且仅在已加载插件钩子的 OpenClaw 进程中运行,因此
操作员自有的安装决策应改用 security.installPolicy。已弃用的
--dangerously-force-unsafe-install 标志出于兼容性仍可接受,
但不会执行任何操作:它不会绕过安装策略或 OpenClaw
内置的插件依赖拒绝列表。
有关 Skills 和插件共用的 security.installPolicy exec 架构,请参阅
Skills 配置。
配置插件策略
通用插件配置结构如下:plugins.enabled: false会禁用所有插件并跳过发现/加载 工作。在此设置生效期间,过时的插件引用会保持非活动状态;如果希望 Doctor 清理过时 ID,请先重新启用插件。plugins.deny的优先级高于允许列表和单插件启用设置。plugins.allow是排他性允许列表。允许列表之外的插件自有工具 会保持不可用,即使tools.allow包含"*"也是如此。plugins.entries.<id>.enabled: false会禁用单个插件,同时保留其 配置。plugins.load.paths可添加显式的本地插件文件或目录。 受管理的plugins install本地路径必须是插件目录或 归档;独立插件文件请使用plugins.load.paths。- 源自工作区的插件默认禁用;使用本地工作区代码前,请显式启用 或将其加入允许列表。
- 内置插件遵循其内置的默认启用/默认禁用元数据, 除非配置显式覆盖。
plugins.slots.<slot>(memory或contextEngine)会为 排他性类别选择一个插件。选择槽位视为显式激活, 并会为该槽位强制启用所选插件,即使该插件原本 需要主动选择加入。plugins.deny和plugins.entries.<id>.enabled: false仍会 阻止它。- 当配置指定内置可选插件自有的某个接口时,该插件可自动激活, 例如提供商/模型引用、渠道配置、CLI 后端 或 Agent harness 运行时。
- OpenAI 系列的 Codex 路由会保持提供商与运行时插件边界
相互独立:旧版 Codex 模型引用属于由 Doctor 修复的旧版配置,
而内置
codex插件负责规范openai/*Agent 引用、显式agentRuntime.id: "codex"以及旧版codex/*引用的 Codex app-server 运行时。
plugins.allow,且从工作区或全局插件根目录自动发现
非内置插件时,启动日志会记录
plugins.allow is empty; discovered non-bundled plugins may auto-load: ...,
其中包含发现的插件 ID;对于较短的列表,还会包含最小化的
plugins.allow 片段。将可信插件复制到 openclaw.json
之前,请对列出的插件 ID 运行 openclaw plugins list --enabled --verbose
或 openclaw plugins inspect <id>。
当诊断信息显示某插件已通过
without install/load-path provenance 加载时,同样需要固定其信任来源:检查该插件 ID,
然后将其固定到 plugins.allow,或从可信来源重新安装,
以便 OpenClaw 记录安装来源。
当配置验证报告过时插件 ID、允许列表/工具不匹配或旧版内置插件
路径时,请运行 openclaw doctor 或 openclaw doctor --fix。
了解插件格式
OpenClaw 可识别两种插件格式:
这两种格式都会出现在
openclaw plugins list、openclaw plugins inspect、
openclaw plugins enable 和 openclaw plugins disable 中。有关包兼容性边界,请参阅
插件包;有关原生插件创作,请参阅
构建插件。
插件钩子
插件可通过两种不同的 API 在运行时注册钩子:api.on(...):用于运行时生命周期事件的类型化钩子。这是 中间件、策略、消息重写、提示词塑形和工具控制的 首选接口。api.registerHook(...):用于 Hooks 中所述的 内部钩子系统。它主要用于粗粒度的命令/生命周期副作用, 以及与现有 HOOK 风格自动化的兼容。
command:new、
command:reset、message:sent 或类似的粗粒度事件,则使用
api.registerHook 即可。
由插件管理的内部钩子会显示在 openclaw hooks list 中,并带有
plugin:<id>。你无法通过 openclaw hooks 启用或禁用这些钩子;
请改为启用或禁用相应插件。
验证活动的 Gateway 网关
openclaw plugins list 和普通的 openclaw plugins inspect 读取冷配置、清单和注册表状态。它们无法证明已在运行的 Gateway 网关导入了相同的插件代码。
当插件显示为已安装,但实时聊天流量未使用它时:
openclaw gateway run 子进程,而不只是包装器或监督进程。
故障排查
当启用的托管插件在 Gateway 网关启动期间未通过载荷验证时,OpenClaw 会在本次启动中隔离该插件实际安装的根目录,并继续为其他插件提供服务。
openclaw status --all、openclaw health 和 openclaw doctor 会将其报告为 configured-unavailable。修复或重新安装插件,然后重启 Gateway 网关。同一插件 ID 的正常显式 plugins.load.paths 覆盖不会因过期的损坏安装而被隔离。
当过期插件配置仍指定一个已无法发现的渠道插件时,配置验证会将该渠道键降级为警告,而不是硬失败,因此 Gateway 网关启动后仍可为其他所有渠道提供服务。运行 openclaw doctor --fix 以移除过期的插件和渠道条目。对于没有过期插件证据的未知渠道键,验证仍会失败,以便让拼写错误保持可见。
对于有意替换渠道的情况,首选插件应声明 channelConfigs.<channel-id>.preferOver,并将其值设为旧版或较低优先级的插件 ID。如果两个插件都被显式启用,OpenClaw 会保留该请求并报告渠道/工具重复诊断,而不是静默选择一个所有者。
如果已安装的软件包报告其 requires compiled runtime output for TypeScript entry ...,说明发布该软件包时未包含 OpenClaw 运行时所需的 JavaScript 文件。请在发布者提供编译后的 JavaScript 后更新或重新安装;在此之前,也可以禁用或卸载该插件。
插件路径所有权被阻止
如果诊断显示blocked plugin candidate: suspicious ownership (... uid=1000, expected uid=0 or root)
且随后验证显示 plugin present but blocked,则 OpenClaw 发现插件文件所属的 Unix 用户与加载它们的进程用户不同。请保留插件配置;修复文件系统所有权,或使用拥有该状态目录的同一用户运行 OpenClaw。
对于 Docker 安装,官方镜像以 node(uid 1000)身份运行,因此从主机绑定挂载的 OpenClaw 配置目录和工作区目录通常应归 uid 1000 所有:
openclaw doctor --fix 或 openclaw plugins registry --refresh,使持久化的插件注册表与修复后的文件保持一致。