Skip to main content

Documentation Index

Fetch the complete documentation index at: https://openclaw.zhcndoc.com/llms.txt

Use this file to discover all available pages before exploring further.

大多数插件工作流只需要几条命令：搜索、安装、重启 Gateway、验证，以及在不再需要该插件时卸载。

​
列出插件

openclaw plugins list
openclaw plugins list --enabled
openclaw plugins list --verbose
openclaw plugins list --json
脚本中使用 --json。它包含注册表诊断信息，以及当插件包声明了 dependencies 或 optionalDependencies 时，每个插件的静态 dependencyStatus。 
openclaw plugins list --json \
  | jq '.plugins[] | {id, enabled, format, source, dependencyStatus}'
plugins list 是一次冷态清单检查。它显示 OpenClaw 能从配置、清单和插件注册表中发现什么；但它不能证明已在运行的 Gateway 进程已经导入了插件运行时。

​
安装插件

# 在 ClawHub 中搜索插件包。
openclaw plugins search "calendar"

# 纯包规格会先尝试 ClawHub，然后回退到 npm。
openclaw plugins install <package>

# 强制使用某个来源。
openclaw plugins install clawhub:<package>
openclaw plugins install npm:<package>

# 安装特定版本或 dist-tag。
openclaw plugins install clawhub:<package>@1.2.3
openclaw plugins install clawhub:<package>@beta
openclaw plugins install npm:@scope/openclaw-plugin@1.2.3
openclaw plugins install npm:@openclaw/codex

# 从 git 或本地开发检出版本安装。
openclaw plugins install git:github.com/acme/openclaw-plugin@v1.0.0
openclaw plugins install ./my-plugin
openclaw plugins install --link ./my-plugin
安装插件代码后，重启为你的通道提供服务的 Gateway： 
openclaw gateway restart
openclaw plugins inspect <plugin-id> --runtime --json
当你需要证明插件已注册运行时表面，例如工具、钩子、服务、Gateway 方法或插件拥有的 CLI 命令时，请使用 inspect --runtime。

​
更新插件

openclaw plugins update <plugin-id>
openclaw plugins update <npm-package-or-spec>
openclaw plugins update --all
如果某个插件是从 npm dist-tag（例如 @beta）安装的，之后调用 update <plugin-id> 会继续使用记录下来的那个标签。传入显式的 npm 规格会把已跟踪的安装切换到该规格，以便后续更新继续使用它。 
openclaw plugins update @scope/openclaw-plugin@beta
openclaw plugins update @scope/openclaw-plugin
第二条命令会在插件之前被固定到精确版本或标签时，将其移回注册表的默认发布线。 当 openclaw update 在 beta 通道上运行时，默认发布线的 npm 和 ClawHub 插件记录会先尝试匹配的插件 @beta 发布。如果该 beta 版本不存在，OpenClaw 会回退到记录中的 default/latest 规格。精确版本和显式标签（例如 @rc 或 @beta）会被保留。

​
卸载插件

openclaw plugins uninstall <plugin-id> --dry-run
openclaw plugins uninstall <plugin-id>
openclaw plugins uninstall <plugin-id> --keep-files
openclaw gateway restart
卸载会移除插件的配置项、插件索引记录、允许/拒绝列表条目，以及在适用情况下的链接加载路径。管理的安装目录会被删除，除非你传入 --keep-files。

​
发布插件

你可以将外部插件发布到 ClawHub、npmjs.com，或者两者都发布。

​
发布到 ClawHub

ClawHub 是 OpenClaw 插件的主要公共发现入口。它会在安装前为用户提供可搜索的元数据、版本历史和注册表扫描结果。 
npm i -g clawhub
clawhub login
clawhub package publish your-org/your-plugin --dry-run
clawhub package publish your-org/your-plugin
clawhub package publish your-org/your-plugin@v1.0.0
用户可以通过以下方式从 ClawHub 安装： 
openclaw plugins install clawhub:<package>
openclaw plugins install <package>
纯包形式仍然会先检查 ClawHub。

​
发布到 npmjs.com

原生 npm 插件必须包含插件清单以及 package.json 中的 OpenClaw 入口元数据。
package.json
{
  "name": "@acme/openclaw-plugin",
  "version": "1.0.0",
  "type": "module",
  "openclaw": {
    "extensions": ["./dist/index.js"]
  }
}

npm publish --access public
用户可以通过以下方式仅从 npm 安装： 
openclaw plugins install npm:@acme/openclaw-plugin
openclaw plugins install npm:@acme/openclaw-plugin@beta
openclaw plugins install npm:@acme/openclaw-plugin@1.0.0
如果同一个包也可在 ClawHub 上获得，npm: 会跳过 ClawHub 查询并强制使用 npm 解析。

​
来源选择

  • ClawHub：当你希望使用 OpenClaw 原生发现、扫描摘要、版本和安装提示时使用。
  • npmjs.com：当你已经在发布 JavaScript 包，或者需要 npm dist-tags/私有仓库工作流时使用。
  • Git：当你想直接从分支、标签或提交安装时使用。
  • 本地路径：当你在同一台机器上开发或测试插件时使用。

​
相关内容