Skip to content
广告 · 本站推荐广告

openclaw hooks

管理 OpenClaw 的事件钩子(Hooks),用于在特定事件发生时触发自定义逻辑。

命令签名

bash
openclaw hooks <子命> [选项]

子命令

子命令说明
list列出所有已发现的钩子
enable启用指定钩子
disable禁用指定钩子
info查看钩子详细信息

openclaw hooks list

列出系统中所有已发现和注册的钩子。

bash
openclaw hooks list [选项]
选项类型说明
--status <status>string按状态过滤:enableddisabled
--event <event>string按事件类型过滤
--jsonbooleanJSON 格式输出

输出示例:

NAME                 EVENT              STATUS     PRIORITY
log-messages         message.received   enabled    100
notify-admin         agent.error        enabled    50
backup-sessions      session.ended      disabled   200
audit-trail          tool.executed      enabled    150

openclaw hooks enable

启用指定的钩子。

bash
openclaw hooks enable <name>

openclaw hooks disable

禁用指定的钩子(不删除)。

bash
openclaw hooks disable <name>

openclaw hooks info

查看钩子的详细信息,包括配置、触发事件和执行历史。

bash
openclaw hooks info <name> [--json]

输出示例:

Hook: log-messages
Event:    message.received
Status:   enabled
Priority: 100
Script:   ~/.openclaw/hooks/log-messages.js
Last Run: 2024-01-15 14:30:22
Runs:     1,247 (3 errors)

事件类型

事件触发时机
message.received收到新消息
message.sent消息发送完成
session.started新会话开始
session.ended会话结束
agent.errorAgent 发生错误
tool.executed工具调用完成
channel.connected渠道连接成功
channel.disconnected渠道断开连接

示例

bash
# 列出所有钩子
openclaw hooks list

# 仅显示已启用的钩子
openclaw hooks list --status enabled

# 按事件类型过滤
openclaw hooks list --event message.received

# 查看钩子详情
openclaw hooks info log-messages

# 启用钩子
openclaw hooks enable backup-sessions

# 禁用钩子
openclaw hooks disable backup-sessions

# JSON 格式输出
openclaw hooks list --json

TIP

钩子脚本存放在 ~/.openclaw/hooks/ 目录下。创建新钩子后运行 openclaw hooks list 确认是否被正确发现。

另请参阅

基于MIT协议开源 | 内容翻译自 官方文档,同步更新