管理 Gateway 网关插件、钩子包和兼容包。Documentation Index
Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt
Use this file to discover all available pages before exploring further.
插件系统
面向最终用户的插件安装、启用和故障排除指南。
管理插件
安装、列出、更新、卸载和发布的快速示例。
插件包
包兼容性模型。
插件清单
清单字段和配置架构。
安全性
插件安装的安全加固。
命令
OPENCLAW_PLUGIN_LIFECYCLE_TRACE=1。跟踪会将阶段耗时写入 stderr,并保持 JSON 输出可解析。参见调试。
在 Nix 模式(
OPENCLAW_NIX_MODE=1)下,插件生命周期变更命令会被禁用。请改用该安装的 Nix 源,而不是 plugins install、plugins update、plugins uninstall、plugins enable 或 plugins disable;对于 nix-openclaw,请使用 agent 优先的快速开始。内置插件随 OpenClaw 一起发布。有些默认启用(例如内置模型提供商、内置语音提供商和内置浏览器插件);其他插件需要运行
plugins enable。原生 OpenClaw 插件必须随附 openclaw.plugin.json,并包含内联 JSON Schema(configSchema,即使为空)。兼容包则使用自己的包清单。plugins list 会显示 Format: openclaw 或 Format: bundle。详细列表/信息输出还会显示包子类型(codex、claude 或 cursor)以及检测到的包能力。安装
plugins search 会查询 ClawHub 中可安装的插件包,并输出可直接安装的包名。它搜索代码插件和包插件包,而不是 Skills。ClawHub Skills 请使用 openclaw skills search。
ClawHub 是大多数插件的主要分发和发现界面。Npm 仍是受支持的回退和直接安装路径。OpenClaw 拥有的
@openclaw/* 插件包已重新发布到 npm;请在 npmjs.com/org/openclaw 或插件清单查看当前列表。稳定版安装使用 latest。Beta 频道的安装和更新会在 npm beta dist-tag 可用时优先使用它,然后回退到 latest。配置 include 和无效配置修复
配置 include 和无效配置修复
如果你的
plugins 部分由单文件 $include 支撑,plugins install/update/enable/disable/uninstall 会写入该被包含的文件,并保持 openclaw.json 不变。根 include、include 数组以及带有同级覆盖的 include 会封闭失败,而不是扁平化。有关受支持的形态,请参见配置 include。如果安装期间配置无效,plugins install 通常会封闭失败,并提示你先运行 openclaw doctor --fix。在 Gateway 网关启动和热重载期间,无效插件配置会像任何其他无效配置一样封闭失败;openclaw doctor --fix 可以隔离该无效插件条目。唯一有文档说明的安装时例外,是针对显式选择加入 openclaw.install.allowInvalidConfigRecovery 的插件的窄范围内置插件恢复路径。--force 和重新安装与更新
--force 和重新安装与更新
--force 会复用现有安装目标,并就地覆盖已安装的插件或钩子包。当你有意从新的本地路径、归档、ClawHub 包或 npm 构件重新安装相同 id 时使用它。对于已跟踪的 npm 插件的常规升级,优先使用 openclaw plugins update <id-or-npm-spec>。如果你对已安装插件 id 运行 plugins install,OpenClaw 会停止,并将你指向 plugins update <id-or-npm-spec> 进行正常升级;如果你确实想从其他来源覆盖当前安装,则指向 plugins install <package> --force。--pin 范围
--pin 范围
--pin 仅适用于 npm 安装。它不支持 git: 安装;如果你想要固定来源,请使用显式 git ref,例如 git:github.com/acme/plugin@v1.2.3。它不支持 --marketplace,因为 marketplace 安装会持久化 marketplace 来源元数据,而不是 npm spec。--dangerously-force-unsafe-install
--dangerously-force-unsafe-install
--dangerously-force-unsafe-install 是用于内置危险代码扫描器误报的应急选项。即使内置扫描器报告 critical 发现,它也允许继续安装,但它不会绕过插件 before_install 钩子策略阻断,也不会绕过扫描失败。此 CLI 标志适用于插件安装/更新流程。由 Gateway 网关支撑的 skill 依赖安装使用对应的 dangerouslyForceUnsafeInstall 请求覆盖,而 openclaw skills install 仍是单独的 ClawHub skill 下载/安装流程。如果你发布到 ClawHub 的插件被注册表扫描阻断,请使用 ClawHub 中的发布者步骤。钩子包和 npm spec
钩子包和 npm spec
plugins install 也是安装在 package.json 中暴露 openclaw.hooks 的钩子包的入口。请使用 openclaw hooks 查看筛选后的钩子可见性并启用单个钩子,而不是安装包。Npm spec 仅限注册表(包名 + 可选的精确版本或 dist-tag)。Git/URL/file spec 和 semver 范围会被拒绝。为安全起见,依赖安装会使用 --ignore-scripts 在项目本地运行,即使你的 shell 配置了全局 npm 安装设置。托管插件 npm 根会继承 OpenClaw 包级别的 npm overrides,因此主机安全固定也会应用到提升的插件依赖。当你想明确使用 npm 解析时,请使用 npm:<package>。裸包 spec 在启动切换期间也会直接从 npm 安装。裸 spec 和 @latest 会留在稳定轨道。OpenClaw 带日期戳的修正版版本(例如 2026.5.3-1)在此检查中属于稳定发布。如果 npm 将其中任一解析为预发布版本,OpenClaw 会停止,并要求你使用预发布标签(例如 @beta/@rc)或精确预发布版本(例如 @1.2.3-beta.4)显式选择加入。如果裸安装 spec 匹配官方插件 id(例如 diffs),OpenClaw 会直接安装目录条目。若要安装同名 npm 包,请使用显式带作用域 spec(例如 @scope/diffs)。Git 仓库
Git 仓库
使用
git:<repo> 可直接从 git 仓库安装。支持的形式包括 git:github.com/owner/repo、git:owner/repo、完整 https://、ssh://、git://、file:// 以及 git@host:owner/repo.git 克隆 URL。添加 @<ref> 或 #<ref> 可在安装前检出分支、标签或提交。Git 安装会克隆到临时目录,在存在所请求的 ref 时检出它,然后使用普通插件目录安装器。这意味着清单验证、危险代码扫描、包管理器安装工作和安装记录的行为都与 npm 安装相同。记录的 git 安装会包含源 URL/ref 以及解析后的提交,以便 openclaw plugins update 后续可以重新解析该来源。从 git 安装后,请使用 openclaw plugins inspect <id> --runtime --json 验证运行时注册,例如 gateway 方法和 CLI 命令。如果插件通过 api.registerCli 注册了 CLI 根,请直接通过 OpenClaw 根 CLI 执行该命令,例如 openclaw demo-plugin ping。归档
归档
支持的归档:
.zip、.tgz、.tar.gz、.tar。原生 OpenClaw 插件归档必须在解压后的插件根目录包含有效的 openclaw.plugin.json;只包含 package.json 的归档会在 OpenClaw 写入安装记录前被拒绝。当文件是 npm-pack tarball,且你想测试与注册表安装相同的托管 npm 根安装路径时,请使用 npm-pack:<path.tgz>,包括 package-lock.json 验证、提升依赖扫描和 npm 安装记录。普通归档路径仍会作为本地归档安装在插件 extensions 根下。也支持 Claude marketplace 安装。clawhub:<package> 定位符:
npm: 可明确仅使用 npm 解析:
.tgz,验证 ClawHub 摘要标头和构件摘要,然后通过常规归档路径安装。没有 ClawPack 元数据的较旧 ClawHub 版本仍会通过旧版包归档验证路径安装。记录的安装会保留其 ClawHub 来源元数据、构件类型、npm integrity、npm shasum、tarball 名称以及 ClawPack 摘要信息,以供后续更新使用。
未指定版本的 ClawHub 安装会保留未指定版本的记录规范,因此 openclaw plugins update 可以跟随更新的 ClawHub 版本;显式版本或标签选择器(例如 clawhub:pkg@1.2.3 和 clawhub:pkg@beta)会继续固定到该选择器。
市场简写
当 Claude 的本地注册表缓存在~/.claude/plugins/known_marketplaces.json 中存在该市场名称时,使用 plugin@marketplace 简写:
--marketplace:
- 市场来源
- 远程市场规则
- 来自
~/.claude/plugins/known_marketplaces.json的 Claude 已知市场名称 - 本地市场根目录或
marketplace.json路径 - GitHub 仓库简写,例如
owner/repo - GitHub 仓库 URL,例如
https://github.com/owner/repo - git URL
- 原生 OpenClaw 插件(
openclaw.plugin.json) - Codex 兼容包(
.codex-plugin/plugin.json) - Claude 兼容包(
.claude-plugin/plugin.json或默认 Claude 组件布局) - Cursor 兼容包(
.cursor-plugin/plugin.json)
兼容包会安装到常规插件根目录,并参与同一套 list/info/enable/disable 流程。目前支持包 Skills、Claude 命令 Skills、Claude
settings.json 默认值、Claude .lsp.json / 清单声明的 lspServers 默认值、Cursor 命令 Skills 以及兼容的 Codex 钩子目录;其他检测到的包能力会显示在 diagnostics/info 中,但尚未接入运行时执行。列出
仅显示已启用的插件。
从表格视图切换到每个插件的详细行,其中包含来源/源点/版本/激活元数据。
机器可读的清单,加上注册表诊断和包依赖安装状态。
plugins list 会先读取持久化的本地插件注册表;当注册表缺失或无效时,回退到仅由清单派生的结果。它适合用于检查插件是否已安装、已启用,以及是否对冷启动规划可见,但它不是对已经运行的 Gateway 网关进程的实时运行时探测。更改插件代码、启用状态、钩子策略或 plugins.load.paths 后,请先重启为该渠道提供服务的 Gateway 网关,再期待新的 register(api) 代码或钩子运行。对于远程/容器部署,请确认你重启的是实际的 openclaw gateway run 子进程,而不只是包装进程。plugins list --json 包含每个插件来自 package.json
dependencies 和 optionalDependencies 的 dependencyStatus。OpenClaw 会检查这些包
名称是否出现在该插件正常 Node node_modules 查找路径上;它
不会导入插件运行时代码、运行包管理器,或修复缺失的
依赖。plugins search 是远程 ClawHub 目录查询。它不会检查本地
状态、变更配置、安装包,或加载插件运行时代码。搜索
结果包含 ClawHub 包名称、族、渠道、版本、摘要,以及
类似 openclaw plugins install clawhub:<package> 的安装提示。
对于打包 Docker 镜像内的内置插件工作,请将插件
源目录 bind-mount 到匹配的打包源路径之上,例如
/app/extensions/synology-chat。OpenClaw 会先发现该挂载的源
覆盖层,然后才是 /app/dist/extensions/synology-chat;普通复制的源
目录保持不生效,因此常规打包安装仍会使用编译后的 dist。
对于运行时钩子调试:
openclaw plugins inspect <id> --runtime --json会显示模块加载检查过程中注册的钩子和诊断。运行时检查永远不会安装依赖;使用openclaw doctor --fix清理旧版依赖状态,或恢复配置引用的缺失可下载插件。openclaw gateway status --deep --require-rpc会确认可访问的 Gateway 网关、服务/进程提示、配置路径以及 RPC 健康状态。- 非内置对话钩子(
llm_input、llm_output、before_model_resolve、before_agent_reply、before_agent_run、before_agent_finalize、agent_end)需要plugins.entries.<id>.hooks.allowConversationAccess=true。
--link 可避免复制本地目录(会添加到 plugins.load.paths):
--force 不支持与 --link 一起使用,因为链接安装会复用源路径,而不是覆盖托管安装目标。在 npm 安装上使用 --pin,可将解析后的精确规范(name@version)保存到托管插件索引中,同时保持默认行为不固定版本。插件索引
插件安装元数据是机器管理的状态,不是用户配置。安装和更新会把它写入活动 OpenClaw 状态目录下的plugins/installs.json。其顶层 installRecords 映射是安装元数据的持久来源,包括损坏或缺失插件清单的记录。plugins 数组是由清单派生的冷注册表缓存。该文件包含不要编辑警告,并由 openclaw plugins update、卸载、诊断以及冷插件注册表使用。
当 OpenClaw 在配置中看到已发布的旧版 plugins.installs 记录时,运行时读取会将它们作为兼容性输入处理,而不会重写 openclaw.json。显式插件写入和 openclaw doctor --fix 会在允许写入配置时把这些记录移动到插件索引,并移除配置键;如果任一写入失败,配置记录会被保留,因此安装元数据不会丢失。
卸载
uninstall 会从 plugins.entries、持久化插件索引、插件允许/拒绝列表条目,以及适用时的链接 plugins.load.paths 条目中移除插件记录。除非设置了 --keep-files,卸载还会在被跟踪的托管安装目录位于 OpenClaw 插件扩展根目录内时移除该目录。对于主动记忆插件,记忆槽位会重置为 memory-core。
--keep-config 作为 --keep-files 的已弃用别名受支持。更新
hooks.internal.installs 中跟踪的 hook-pack 安装。
解析插件 id 与 npm 规范
解析插件 id 与 npm 规范
当你传入插件 id 时,OpenClaw 会复用该插件记录的安装规范。这意味着之前存储的 dist-tag(例如
@beta)和精确固定版本会在后续 update <id> 运行中继续使用。对于 npm 安装,你也可以传入带 dist-tag 或精确版本的显式 npm 包规范。OpenClaw 会将该包名称解析回被跟踪的插件记录,更新该已安装插件,并记录新的 npm 规范以供后续基于 id 的更新使用。传入不带版本或标签的 npm 包名称也会解析回被跟踪的插件记录。当插件已固定到精确版本,而你想把它移回注册表的默认发布线时,请使用这种方式。Beta 渠道更新
Beta 渠道更新
openclaw plugins update 会复用被跟踪的插件规范,除非你传入新规范。openclaw update 还知道活动的 OpenClaw 更新渠道:在 beta 渠道上,默认线 npm 和 ClawHub 插件记录会先尝试 @beta,如果不存在插件 beta 版本,则回退到记录的默认/latest 规范。该回退会以警告形式报告,并且不会导致核心更新失败。精确版本和显式标签会保持固定到该选择器。版本检查和完整性漂移
版本检查和完整性漂移
在实时 npm 更新之前,OpenClaw 会根据 npm 注册表元数据检查已安装包版本。如果已安装版本和记录的构件身份已经与解析后的目标匹配,则会跳过更新,不下载、不重新安装,也不重写
openclaw.json。当存在已存储的完整性哈希且获取到的构件哈希发生变化时,OpenClaw 会将其视为 npm 构件漂移。交互式 openclaw plugins update 命令会打印预期和实际哈希,并在继续之前请求确认。非交互式更新辅助工具会默认失败关闭,除非调用方提供显式继续策略。更新时的 --dangerously-force-unsafe-install
更新时的 --dangerously-force-unsafe-install
--dangerously-force-unsafe-install 也可用于 plugins update,作为插件更新期间内置危险代码扫描误报的紧急覆盖。它仍不会绕过插件 before_install 策略阻断或扫描失败阻断,并且只适用于插件更新,不适用于 hook-pack 更新。检查
--runtime 可加载插件模块,并包含已注册的钩子、工具、命令、服务、Gateway 网关方法以及 HTTP 路由。运行时检查会直接报告缺失的插件依赖;安装和修复保留在 openclaw plugins install、openclaw plugins update 和 openclaw doctor --fix 中。
插件拥有的 CLI 命令通常作为根 openclaw 命令组安装,但插件也可以在核心父级下注册嵌套命令,例如 openclaw nodes。在 inspect --runtime 的 cliCommands 下显示某个命令后,请按列出的路径运行它;例如,注册 demo-git 的插件可用 openclaw demo-git ping 验证。
每个插件会按其在运行时实际注册的内容分类:
- plain-capability — 一种能力类型(例如仅提供商插件)
- hybrid-capability — 多种能力类型(例如文本 + 语音 + 图像)
- hook-only — 仅钩子,没有能力或界面
- non-capability — 工具/命令/服务,但没有能力
--json 标志会输出适合脚本编写和审计的机器可读报告。inspect --all 会渲染一张覆盖全部插件的表格,包含形态、能力种类、兼容性提示、内置能力和钩子摘要列。info 是 inspect 的别名。Doctor
doctor 会报告插件加载错误、清单/设备发现诊断以及兼容性提示。当一切正常时,它会打印 No plugin issues detected.
如果已配置的插件存在于磁盘上,但被加载器的路径安全检查阻止,配置验证会保留该插件条目,并将其报告为 present but blocked。请修复前面的被阻止插件诊断,例如路径所有权或全局可写权限,而不是移除 plugins.entries.<id> 或 plugins.allow 配置。
对于缺少 register/activate 导出等模块形态失败,请使用 OPENCLAW_PLUGIN_LOAD_DEBUG=1 重新运行,以便在诊断输出中包含紧凑的导出形态摘要。
注册表
plugins registry 检查持久化注册表是否存在、是否为当前版本或是否已过期。使用 --refresh 可基于持久化插件索引、配置策略以及清单/包元数据重建它。这是修复路径,不是运行时激活路径。
openclaw doctor --fix 也会修复与注册表相邻的受管 npm 漂移:如果受管插件 npm 根目录下孤立或恢复的 @openclaw/* 包遮蔽了内置插件,Doctor 会移除该过期包并重建注册表,使启动流程根据内置清单进行验证。Doctor 还会将宿主 openclaw 包重新链接到声明了 peerDependencies.openclaw 的受管 npm 插件中,使 openclaw/plugin-sdk/* 等包本地运行时导入在更新或 npm 修复后能够解析。
市场
marketplace.json 路径、类似 owner/repo 的 GitHub 简写、GitHub 仓库 URL 或 git URL。--json 会打印解析后的来源标签,以及解析出的市场清单和插件条目。