openclaw hooks
管理代理钩子(用于 /new、/reset 等命令和网关启动的事件驱动自动化)。
相关内容:
列出所有钩子
bash
openclaw hooks list列出从工作区、托管和捆绑目录中发现的所有钩子。
选项:
--eligible:仅显示符合条件的钩子(满足要求)--json:以 JSON 格式输出-v, --verbose:显示详细信息,包括缺少的要求
输出示例:
Hooks (4/4 ready)
Ready:
🚀 boot-md ✓ - Run BOOT.md on gateway startup
📝 command-logger ✓ - Log all command events to a centralized audit file
💾 session-memory ✓ - Save session context to memory when /new command is issued
😈 soul-evil ✓ - Swap injected SOUL content during a purge window or by random chance示例(详细模式):
bash
openclaw hooks list --verbose显示不符合条件的钩子缺少的要求。
示例(JSON 格式):
bash
openclaw hooks list --json返回结构化 JSON 供程序化使用。
获取钩子信息
bash
openclaw hooks info <name>显示特定钩子的详细信息。
参数:
<name>:钩子名称(例如session-memory)
选项:
--json:以 JSON 格式输出
示例:
bash
openclaw hooks info session-memory输出:
💾 session-memory ✓ Ready
Save session context to memory when /new command is issued
Details:
Source: openclaw-bundled
Path: /path/to/openclaw/hooks/bundled/session-memory/HOOK.md
Handler: /path/to/openclaw/hooks/bundled/session-memory/handler.ts
Homepage: https://docs.openclaw.ai/hooks#session-memory
Events: command:new
Requirements:
Config: ✓ workspace.dir检查钩子资格状态
bash
openclaw hooks check显示钩子资格状态摘要(有多少已就绪与未就绪)。
选项:
--json:以 JSON 格式输出
输出示例:
Hooks Status
Total hooks: 4
Ready: 4
Not ready: 0启用钩子
bash
openclaw hooks enable <name>通过将其添加到您的配置(~/.openclaw/config.json)来启用特定钩子。
注意: 由插件管理的钩子在 openclaw hooks list 中显示 plugin:<id>, 无法在此处启用/禁用。请改为启用/禁用该插件。
参数:
<name>:钩子名称(例如session-memory)
示例:
bash
openclaw hooks enable session-memory输出:
✓ Enabled hook: 💾 session-memory它的作用:
- 检查钩子是否存在且符合条件
- 更新配置中的
hooks.internal.entries.<name>.enabled = true - 将配置保存到磁盘
启用后:
- 重启网关以重新加载钩子(在 macOS 上重启菜单栏应用,或在开发环境中重启网关进程)。
禁用钩子
bash
openclaw hooks disable <name>通过更新配置来禁用特定钩子。
参数:
<name>:钩子名称(例如command-logger)
示例:
bash
openclaw hooks disable command-logger输出:
⏸ Disabled hook: 📝 command-logger禁用后:
- 重启网关以重新加载钩子
安装钩子
bash
openclaw hooks install <path-or-spec>从本地文件夹/归档或 npm 安装钩子包。
它的作用:
- 将钩子包复制到
~/.openclaw/hooks/<id> - 在
hooks.internal.entries.*中启用已安装的钩子 - 在
hooks.internal.installs下记录安装信息
选项:
-l, --link:链接本地目录而不是复制(将其添加到hooks.internal.load.extraDirs)
支持的归档格式: .zip、.tgz、.tar.gz、.tar
示例:
bash
# Local directory
openclaw hooks install ./my-hook-pack
# Local archive
openclaw hooks install ./my-hook-pack.zip
# NPM package
openclaw hooks install @openclaw/my-hook-pack
# Link a local directory without copying
openclaw hooks install -l ./my-hook-pack更新钩子
bash
openclaw hooks update <id>
openclaw hooks update --all更新已安装的钩子包(仅限 npm 安装)。
选项:
--all:更新所有被跟踪的钩子包--dry-run:显示将要发生的更改而不写入
捆绑钩子
session-memory
当您执行 /new 时将会话上下文保存到内存。
启用:
bash
openclaw hooks enable session-memory输出: ~/.openclaw/workspace/memory/YYYY-MM-DD-slug.md
command-logger
将所有命令事件记录到集中的审计文件。
启用:
bash
openclaw hooks enable command-logger输出: ~/.openclaw/logs/commands.log
查看日志:
bash
# Recent commands
tail -n 20 ~/.openclaw/logs/commands.log
# Pretty-print
cat ~/.openclaw/logs/commands.log | jq .
# Filter by action
grep '"action":"new"' ~/.openclaw/logs/commands.log | jq .soul-evil
在清除窗口期间或以随机概率将注入的 SOUL.md 内容替换为 SOUL_EVIL.md。
启用:
bash
openclaw hooks enable soul-evil参见: SOUL Evil 钩子
boot-md
在网关启动时运行 BOOT.md(在通道启动后)。
事件: gateway:startup
启用:
bash
openclaw hooks enable boot-md参见: boot-md 文档