Hooks

Hooks 是在智能体事件触发时于 Gateway 网关内部运行的小型脚本：例如 /new、/reset、/stop 等命令、会话压缩、Gateway 网关生命周期和消息流。系统会从目录中发现它们，并通过 openclaw hooks 进行管理。只有在你启用 Hooks，或配置至少一个 Hook 条目、Hook 包、旧版处理程序或额外 Hook 目录后，Gateway 网关才会加载内部 Hooks。

OpenClaw 中有两类 Hooks：

• 内部钩子（本页）：在智能体事件触发时于 Gateway 网关内部运行。
• Webhooks：允许其他系统在 OpenClaw 中触发工作的外部 HTTP 端点。请参阅 Webhooks。

Hooks 也可以内置在插件中。openclaw hooks list 会同时显示独立 Hooks 和由插件管理的 Hooks（显示为 plugin:<id>）。

选择正确的扩展机制

OpenClaw 提供了几种看起来相似、但解决不同问题的扩展机制：

如果你需要行为类似小型已安装集成的自动化，请使用内部 Hooks。如果你需要控制运行时生命周期，请使用类型化插件钩子。

快速开始

# 列出可用 Hooksopenclaw hooks list # 启用 Hookopenclaw hooks enable session-memory # 检查 Hook 状态openclaw hooks check # 获取详细信息openclaw hooks info session-memory

事件类型

Hooks 可以订阅下表中的特定键，也可以订阅不带操作的事件族名称 （command、session、agent、gateway、message），以接收该事件族中的所有操作。 OpenClaw 核心不会发出除此以外的事件，因此其他名称几乎总是拼写错误， 会导致 Hook 无提示地永远无法运行（只有发出自定义事件的插件才能触发它）。 Hook 加载器会针对这类名称记录警告（例如 command:nwe）， openclaw hooks info <name> 也会标记它们，因此可以诊断从未运行的 Hook。

编写 Hooks

Hook 结构

每个 Hook 都是一个包含两个文件的目录：

my-hook/├── HOOK.md          # 元数据 + 文档└── handler.ts       # 处理程序实现

处理程序文件可以是 handler.ts、handler.js、index.ts 或 index.js。

HOOK.md 格式

---name: my-hookdescription: "此 Hook 功能的简短说明"metadata:  { "openclaw": { "emoji": "🔗", "events": ["command:new"], "requires": { "bins": ["node"] } } }--- # 我的 Hook 此处提供详细文档。

元数据字段（metadata.openclaw）：

处理程序实现

const handler = async (event) => {  if (event.type !== "command" || event.action !== "new") {    return;  }   console.log(`[my-hook] New command triggered`);  // 在此处添加你的逻辑   // 可选择在支持回复的扩展机制上发送回复  event.messages.push("Hook executed!");}; export default handler;

每个事件都包含：type、action、sessionKey、timestamp、messages 和 context（特定于事件的数据）。用于智能体和工具 Hooks 的类型化插件 Hook 上下文还可以包含 trace，这是一个只读、兼容 W3C 的诊断跟踪上下文，插件可以将其传入结构化日志，以便进行 OTEL 关联。

只有对于 command:new 和 command:reset，推送到 event.messages 的字符串才会传回聊天 （作为对原始会话的回复进行路由）；对于 session:compact:before 和 session:compact:after，这些字符串会作为压缩状态通知发送。包括 command:stop、message:*、agent:bootstrap、session:patch 和 gateway:* 在内的所有其他事件都会忽略推送的消息。

事件上下文要点

命令事件（command:new、command:reset）：context.sessionEntry、context.previousSessionEntry、context.commandSource、context.senderId、context.workspaceDir、context.cfg。

命令事件（command:stop）：context.sessionEntry、context.sessionId、context.commandSource、context.senderId。

消息事件（message:received）：context.from、context.content、context.channelId、context.metadata（特定于提供商的数据，包括 senderId、senderName、guildId）。对于类似命令的消息，context.content 会优先使用非空的命令正文，然后回退到原始入站正文和通用正文；它不包含仅供智能体使用的增强信息，例如线程历史记录或链接摘要。

消息事件（message:sent）：context.to、context.content、context.success、context.channelId，发送失败时还包括 context.error。

消息事件（message:transcribed）：context.transcript、context.from、context.channelId、context.mediaPath。

消息事件（message:preprocessed）：context.bodyForAgent（最终增强后的正文）、context.from、context.channelId。

引导事件（agent:bootstrap）：context.bootstrapFiles（可变数组）、context.agentId。

会话补丁事件（session:patch）：context.sessionEntry、context.patch（仅包含已更改的字段）、context.cfg。只有具备权限的客户端才能触发补丁事件；上下文是一个副本，因此处理程序无法修改实时会话条目。

压缩事件：session:compact:before 包含 messageCount、tokenCount。session:compact:after 还会添加 compactedCount、summaryLength、tokensBefore、tokensAfter。

command:stop 用于观察用户发出 /stop 的行为；它属于取消或命令 生命周期，而不是智能体最终完成的门控机制。需要检查自然生成的最终回答， 并要求智能体再执行一轮的插件应改用类型化插件钩子 before_agent_finalize。请参阅插件钩子。

Gateway 网关生命周期事件：gateway:shutdown 包含 reason 和 restartExpectedMs，并在 Gateway 网关开始关闭时触发。gateway:pre-restart 包含相同的上下文，但仅当关闭是预期重启的一部分，并且提供了有限的 restartExpectedMs 值时才会触发。在关闭期间，对每个生命周期 Hook 的等待都会尽力而为并受到时间限制，因此即使处理程序停滞，关闭过程也会继续。gateway:shutdown 的默认等待时限为 5 秒，gateway:pre-restart 的默认等待时限为 10 秒。

在渠道仍然可用时，使用 gateway:pre-restart 发送简短的重启通知：

  const execFileAsync = promisify(execFile); export default async function handler(event) {  if (event.type !== "gateway" || event.action !== "pre-restart") {    return;  }   const restartInSeconds = Math.ceil(event.context.restartExpectedMs / 1000);  await execFileAsync("openclaw", [    "system",    "event",    "--mode",    "now",    "--text",    `Gateway restarting in ~${restartInSeconds}s (${event.context.reason}). Checkpoint now.`,  ]);}

在 gateway:shutdown（或 gateway:pre-restart）事件与关闭流程的其余阶段之间，Gateway 网关还会针对进程停止时仍处于活动状态的每个会话触发类型化的 session_end 插件钩子。对于普通的 SIGTERM/SIGINT 停止，事件的 reason 为 shutdown；当关闭是预期重启计划的一部分时，则为 restart。此清理过程受到时间限制，因此缓慢的 session_end 处理程序无法阻止进程退出；对于已经通过替换、重置、删除或压缩完成终结的会话，系统会跳过处理，以避免重复触发。

Hook 发现

系统会从四个来源发现 Hooks：

1. 内置 Hooks：随 OpenClaw 一同发布
2. 插件 Hooks：内置于已安装的插件中；可以覆盖同名的内置 Hooks
3. 托管 Hooks：~/.openclaw/hooks/（由用户安装，并在工作区之间共享）；可以覆盖内置 Hooks 和插件 Hooks。hooks.internal.load.extraDirs 中的额外目录具有相同的优先级。
4. 工作区 Hooks：<workspace>/hooks/（按智能体配置，默认禁用，直到显式启用）

工作区 Hooks 可以添加新的 Hook 名称，但不能覆盖由内置、托管或插件提供的同名 Hooks。

在配置内部 Hooks 之前，Gateway 网关启动时会跳过内部 Hook 发现。使用 openclaw hooks enable <name> 启用内置或托管 Hook、安装 Hook 包，或设置 hooks.internal.enabled=true 以选择启用。当你启用一个具名 Hook 时，Gateway 网关只会加载该 Hook 的处理程序；hooks.internal.enabled=true、额外 Hook 目录和旧版处理程序则会选择启用广泛发现。

Hook 包

Hook 包是通过 package.json 中的 openclaw.hooks 导出 Hooks 的 npm 包。安装命令如下：

openclaw plugins install <path-or-spec>

Npm 规格仅限注册表（包名 + 可选的精确版本或 dist-tag）。Git/URL/文件规格和 semver 范围会被拒绝。旧版 openclaw hooks install 和 openclaw hooks update 命令是 openclaw plugins install / openclaw plugins update 的已弃用别名。

内置钩子

启用任意内置钩子：

openclaw hooks enable <hook-name>

session-memory 详情

提取最近的用户/助手消息（默认 15 条，可通过 hooks.internal.entries.session-memory.messages 配置），并使用主机本地日期将其保存到 <workspace>/memory/YYYY-MM-DD-HHMM.md。记忆捕获在后台运行，因此 /new 和 /reset 的确认不会因读取转录记录或可选的短标识生成而延迟。将 hooks.internal.entries.session-memory.llmSlug: true 设为启用可生成描述性的文件名短标识，还可选择将 hooks.internal.entries.session-memory.model 设置为已配置的别名（如 sonnet）、智能体默认提供商上的纯模型 ID，或 provider/model 引用。省略 model 时，短标识生成会使用智能体的默认模型；如果不可用，则回退到时间戳短标识。需要配置 workspace.dir。

bootstrap-extra-files 配置

{  "hooks": {    "internal": {      "entries": {        "bootstrap-extra-files": {          "enabled": true,          "paths": ["packages/*/AGENTS.md", "packages/*/TOOLS.md"]        }      }    }  }}

patterns 和 files 可作为 paths 的别名。路径相对于工作区解析，并且必须保持在工作区内。仅加载可识别的引导文件基本名称（AGENTS.md、SOUL.md、TOOLS.md、IDENTITY.md、USER.md、HEARTBEAT.md、BOOTSTRAP.md、MEMORY.md）。

command-logger 详情

将每个斜杠命令作为一行 JSON（时间戳、操作、会话键、发送者 ID、来源）记录到 ~/.openclaw/logs/commands.log。

compaction-notifier 详情

当 OpenClaw 开始和完成会话转录记录压缩时，向当前对话发送简短的状态消息。这样可减少聊天界面上长轮次带来的困惑，因为用户可以看到助手正在汇总上下文，并将在压缩后继续。

boot-md 详情

Gateway 网关启动时，如果每个已配置智能体范围对应智能体的已解析工作区中存在 BOOT.md，则运行该文件。

插件钩子

插件可以通过插件 SDK 注册类型化钩子，以实现更深层次的集成： 拦截工具调用、修改提示词、控制消息流等。 当你需要 before_tool_call、before_agent_reply、 before_install 或其他进程内生命周期钩子时，请使用插件钩子。

插件管理的内部钩子有所不同：它们参与本页所述的粗粒度命令/生命周期事件系统，并在 openclaw hooks list 中显示为 plugin:<id>。这些钩子适用于副作用以及与钩子包保持兼容，而不适用于有序中间件或策略门控。

有关完整的插件钩子参考，请参阅插件钩子。

配置

{  "hooks": {    "internal": {      "enabled": true,      "entries": {        "session-memory": { "enabled": true },        "command-logger": { "enabled": false }      }    }  }}

每个钩子的环境变量值可满足该钩子的 requires.env 资格检查（与进程环境一起检查），处理程序也可从对应的钩子配置条目中读取这些值：

{  "hooks": {    "internal": {      "entries": {        "my-hook": {          "enabled": true,          "env": { "MY_CUSTOM_VAR": "value" }        }      }    }  }}

额外的钩子目录：

{  "hooks": {    "internal": {      "load": {        "extraDirs": ["/path/to/more/hooks"]      }    }  }}

CLI 参考

# 列出所有钩子（添加 --eligible、--verbose 或 --json）openclaw hooks list # 显示钩子的详细信息openclaw hooks info <hook-name> # 显示资格摘要openclaw hooks check # 启用/禁用openclaw hooks enable <hook-name>openclaw hooks disable <hook-name>

最佳实践

• 保持处理程序快速。 钩子在命令处理期间运行。使用 void processInBackground(event) 以触发后不等待的方式执行繁重工作。
• 妥善处理错误。 使用 try/catch 包装有风险的操作；不要抛出错误，以便其他处理程序可以运行。
• 尽早筛选事件。 如果事件类型/操作不相关，请立即返回。
• 使用具体的事件键。 优先使用 "events": ["command:new"]，而不是 "events": ["command"]，以减少开销。

故障排查

未发现钩子

# 验证目录结构ls -la ~/.openclaw/hooks/my-hook/# 应显示：HOOK.md、handler.ts # 列出所有已发现的钩子openclaw hooks list

钩子不符合资格

openclaw hooks info my-hook

检查是否缺少二进制文件（PATH）、环境变量、配置值或操作系统兼容性。

钩子未执行

1. 验证钩子是否已启用：openclaw hooks list
2. 重启 Gateway 网关进程，以便重新加载钩子。
3. 检查 Gateway 网关日志：openclaw logs --follow | grep -i hook

相关内容

• CLI 参考：钩子
• Webhooks
• 插件钩子 — 进程内插件生命周期钩子
• 配置