openclaw hooks
管理智能体 Hooks(由事件驱动的自动化,用于 /new、/reset 和 Gateway 网关启动等命令)。裸 openclaw hooks 等同于 openclaw hooks list。
相关:Hooks - 插件钩子
列出 Hooks
--eligible:仅显示满足要求的 Hooks。--json:结构化输出。-v, --verbose:包含 Missing 列,显示未满足的要求。
获取 Hook 信息
<name> 是 Hook 名称或 Hook 键(例如 session-memory)。显示来源、文件/处理器路径、主页、事件,以及每项要求的状态(二进制文件、环境变量、配置、操作系统)。
检查可用性
启用 Hook
hooks.internal.entries.<name>.enabled = true,并同时打开 hooks.internal.enabled 主开关(Gateway 网关在至少配置一个内部 Hook 处理器之前不会加载任何内部 Hook 处理器)。如果 Hook 不存在、由插件管理,或不可用(缺少要求),则会失败。
插件管理的 Hooks 会在 hooks list 中显示 plugin:<id>,无法在这里启用/禁用;请改为启用或禁用所属插件。
启用后重启 Gateway 网关(重启 macOS 菜单栏应用,或在开发中重启你的 Gateway 网关进程),使其重新加载 Hooks。
禁用 Hook
hooks.internal.entries.<name>.enabled = false。之后重启 Gateway 网关。
安装和更新 Hook 包
openclaw hooks install / openclaw hooks update 仍可作为已弃用别名使用,它们会打印警告并转发到 plugins 命令。
- Npm 规格仅限注册表:包名加可选的精确版本或 dist-tag。Git/URL/file 规格和 semver 范围会被拒绝。依赖安装在项目本地运行,并带有
--ignore-scripts。 - 裸规格和
@latest保持在稳定轨道;如果 npm 解析到预发布版本,OpenClaw 会停止并要求你显式选择加入(@beta、@rc,或精确的预发布版本)。 - 支持的归档格式:
.zip、.tgz、.tar.gz、.tar。 -l, --link会链接本地目录而不是复制它(将其添加到hooks.internal.load.extraDirs);链接的 Hook 包是来自操作员配置目录的托管 Hooks,而不是工作区 Hooks。--pin会将 npm 安装记录为hooks.internal.installs中精确解析出的name@version。- 安装会将包复制到
~/.openclaw/hooks/<id>,在hooks.internal.entries.*下启用其 Hooks,并将安装记录到hooks.internal.installs。 - 如果已存储的完整性哈希不再匹配获取到的制品,OpenClaw 会警告并在继续前提示;传递全局
--yes可绕过提示(例如在 CI 中)。
内置 Hooks
| Hook | 事件 | 作用 |
|---|---|---|
| boot-md | gateway:startup | 在 Gateway 网关启动时,为每个已配置的智能体作用域运行 BOOT.md |
| bootstrap-extra-files | agent:bootstrap | 在智能体引导启动期间注入额外的引导启动文件(例如 monorepo AGENTS.md/TOOLS.md) |
| command-logger | command | 将命令事件记录到 ~/.openclaw/logs/commands.log |
| compaction-notifier | session:compact:before, session:compact:after | 在会话压缩开始和结束时发送可见的聊天通知 |
| session-memory | command:new, command:reset | 在 /new 或 /reset 时将会话上下文保存到记忆 |
openclaw hooks enable <hook-name> 启用任何内置 Hook。完整详情、配置键和默认值:内置 Hooks。
command-logger 日志文件
说明
hooks list --json、info --json和check --json会将结构化 JSON 直接写入 stdout。