Hooks

Hooks

Hooks 提供了一个可扩展的事件驱动系统，用于自动执行响应代理命令和事件的操作。Hooks 会从目录中自动发现，并可以通过 CLI 命令进行管理，类似于技能在 OpenClaw 中的工作方式。

入门指南

Hooks 是在发生某些情况时运行的小型脚本。有两种类型：

• Hooks (本页)：当代理事件触发时在 Gateway 网关 内部运行，例如 /new、/reset、/stop 或生命周期事件。
• Webhooks：外部 HTTP Webhook，允许其他系统在 OpenClaw 中触发工作。请参阅 Webhook Hooks 或使用 openclaw webhooks 获取 Gmail 辅助命令。

Hooks 也可以打包在插件内部；请参阅 Plugins。

常见用途：

• 重置会话时保存内存快照
• 保留命令的审计跟踪以便进行故障排除或合规检查
• 在会话开始或结束时触发后续自动化
• 在事件触发时将文件写入代理工作区或调用外部 API

如果您能编写一个小型 TypeScript 函数，就可以编写一个 hook。Hooks 会自动被发现，您可以通过 CLI 启用或禁用它们。

概述

Hooks 系统允许您：

• 当发出 /new 时，将会话上下文保存到内存
• 记录所有命令以进行审计
• 在代理生命周期事件上触发自定义自动化
• 在不修改核心代码的情况下扩展 OpenClaw 的行为

入门

内置 Hooks

OpenClaw 附带了四个自动发现的内置 hooks：

• 💾 会话-memory：当您发出 /new 时，将会话上下文保存到您的工作区（默认为 ~/.openclaw/workspace/memory/）
• 📝 command-logger：将所有命令事件记录到 ~/.openclaw/logs/commands.log
• 🚀 boot-md：在网关启动时运行 BOOT.md（需要启用内部 hooks）
• 😈 soul-evil：在清除窗口期间或随机机会中，将注入的 SOUL.md 内容交换为 SOUL_EVIL.md

列出可用的 hooks：

openclaw hooks list

启用 hook：

openclaw hooks enable session-memory

检查 hook 状态：

openclaw hooks check

获取详细信息：

openclaw hooks info session-memory

入职引导

在入职（openclaw onboard）期间，系统将提示您启用推荐的 hooks。向导会自动发现符合条件的 hooks 并将其显示出来供您选择。

Hook 发现

Hooks 会从三个目录中自动发现（按优先级顺序）：

1. 工作区 hooks：<workspace>/hooks/（每个代理，优先级最高）
2. 托管 hooks：~/.openclaw/hooks/（用户安装，在工作区之间共享）
3. 内置 hooks：<openclaw>/dist/hooks/bundled/（随 OpenClaw 附带）

托管的 hook 目录可以是单个 hook 或 hook 包（package 目录）。

每个 hook 是一个包含以下内容的目录：

my-hook/
├── HOOK.md          # Metadata + documentation
└── handler.ts       # Handler implementation

Hook 包 (npm/archives)

Hook 包是标准的 npm 包，通过 openclaw.hooks 在 package.json 中导出一个或多个 hooks。 使用以下命令安装：

openclaw hooks install <path-or-spec>

package.json 示例：

{
  "name": "@acme/my-hooks",
  "version": "0.1.0",
  "openclaw": {
    "hooks": ["./hooks/my-hook", "./hooks/other-hook"]
  }
}

每个条目指向一个包含 HOOK.md 和 handler.ts（或 index.ts）的 hook 目录。 Hook 包可以附带依赖项；它们将安装在 ~/.openclaw/hooks/<id> 下。

Hook 结构

HOOK.md 格式

HOOK.md 文件包含 YAML frontmatter 中的元数据和 Markdown 文档：

---
name: my-hook
description: "Short description of what this hook does"
homepage: https://docs.openclaw.ai/hooks#my-hook
metadata:
  { "openclaw": { "emoji": "🔗", "events": ["command:new"], "requires": { "bins": ["node"] } } }
---

# My Hook

Detailed documentation goes here...

## What It Does

- Listens for `/new` commands
- Performs some action
- Logs the result

## Requirements

- Node.js must be installed

## Configuration

No configuration needed.

元数据字段

metadata.openclaw 对象支持：

• emoji：用于 CLI 显示的表情符号（例如 "💾"）
• events：要监听的事件数组（例如 ["command:new", "command:reset"]）
• export：要使用的命名导出（默认为 "default"）
• homepage：文档 URL
• requires：可选要求
  • bins：PATH 上所需的二进制文件（例如 ["git", "node"]）
  • anyBins：必须至少存在其中一个二进制文件
  • env：所需的环境变量
  • config：所需的配置路径（例如 ["workspace.dir"]）
  • os：所需的平台（例如 ["darwin", "linux"]）
• always：绕过资格检查（布尔值）
• install：安装方法（对于打包的 hooks：[{"id":"bundled","kind":"bundled"}]）

处理器实现

handler.ts 文件导出一个 HookHandler 函数：

import type { HookHandler } from "../../src/hooks/hooks.js";

const myHandler: HookHandler = async (event) => {
  // Only trigger on 'new' command
  if (event.type !== "command" || event.action !== "new") {
    return;
  }

  console.log(`[my-hook] New command triggered`);
  console.log(`  Session: ${event.sessionKey}`);
  console.log(`  Timestamp: ${event.timestamp.toISOString()}`);

  // Your custom logic here

  // Optionally send message to user
  event.messages.push("✨ My hook executed!");
};

export default myHandler;

事件上下文

每个事件包括：

{
  type: 'command' | 'session' | 'agent' | 'gateway',
  action: string,              // e.g., 'new', 'reset', 'stop'
  sessionKey: string,          // Session identifier
  timestamp: Date,             // When the event occurred
  messages: string[],          // Push messages here to send to user
  context: {
    sessionEntry?: SessionEntry,
    sessionId?: string,
    sessionFile?: string,
    commandSource?: string,    // e.g., 'whatsapp', 'telegram'
    senderId?: string,
    workspaceDir?: string,
    bootstrapFiles?: WorkspaceBootstrapFile[],
    cfg?: OpenClawConfig
  }
}

事件类型

命令事件

在发出代理命令时触发：

• command：所有命令事件（通用侦听器）
• command:new：当发出 /new 命令时
• command:reset：当发出 /reset 命令时
• command:stop：当发出 /stop 命令时

代理事件

• agent:bootstrap：在注入工作区引导文件之前（hooks 可以更改 context.bootstrapFiles）

Gateway 网关 事件

在 Gateway 启动时触发：

• gateway:startup：在通道启动且 hooks 加载之后

工具结果钩子

这些钩子不是事件流监听器；它们允许插件在 OpenClaw 持久化工具结果之前同步调整这些结果。

• tool_result_persist：在工具结果写入会话记录之前对其进行转换。必须是同步的；返回更新后的工具结果负载或 undefined 以保持原样。请参阅 Agent Loop。

未来事件

计划中的事件类型：

• session:start：当新会话开始时
• session:end：当会话结束时
• agent:error：当代理遇到错误时
• message:sent：当发送消息时
• message:received：当接收消息时

创建自定义 Hooks

1. 选择位置

• Workspace hooks (<workspace>/hooks/)：针对每个代理，优先级最高
• Managed hooks (~/.openclaw/hooks/)：在工作区之间共享

2. 创建目录结构

mkdir -p ~/.openclaw/hooks/my-hook
cd ~/.openclaw/hooks/my-hook

3. 创建 HOOK.md

---
name: my-hook
description: "Does something useful"
metadata: { "openclaw": { "emoji": "🎯", "events": ["command:new"] } }
---

# My Custom Hook

This hook does something useful when you issue `/new`.

4. 创建 handler.ts

import type { HookHandler } from "../../src/hooks/hooks.js";

const handler: HookHandler = async (event) => {
  if (event.type !== "command" || event.action !== "new") {
    return;
  }

  console.log("[my-hook] Running!");
  // Your logic here
};

export default handler;

5. 启用和测试

# Verify hook is discovered
openclaw hooks list

# Enable it
openclaw hooks enable my-hook

# Restart your gateway process (menu bar app restart on macOS, or restart your dev process)

# Trigger the event
# Send /new via your messaging channel

配置

新配置格式（推荐）

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

单个 Hook 的配置

Hooks 可以具有自定义配置：

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

额外目录

从其他目录加载 hooks：

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

旧配置格式（仍然支持）

为了向后兼容，旧的配置格式仍然有效：

{
  "hooks": {
    "internal": {
      "enabled": true,
      "handlers": [
        {
          "event": "command:new",
          "module": "./hooks/handlers/my-handler.ts",
          "export": "default"
        }
      ]
    }
  }
}

迁移：对于新的 hooks，请使用新的基于发现的系统。旧的处理程序在基于目录的 hooks 之后加载。

CLI 命令

列出 Hooks

# List all hooks
openclaw hooks list

# Show only eligible hooks
openclaw hooks list --eligible

# Verbose output (show missing requirements)
openclaw hooks list --verbose

# JSON output
openclaw hooks list --json

Hook 信息

# Show detailed info about a hook
openclaw hooks info session-memory

# JSON output
openclaw hooks info session-memory --json

检查资格

# Show eligibility summary
openclaw hooks check

# JSON output
openclaw hooks check --json

启用/禁用

# Enable a hook
openclaw hooks enable session-memory

# Disable a hook
openclaw hooks disable command-logger

捆绑的 Hooks

会话-memory

当您发出 /new 时，将会话上下文保存到内存。

事件：command:new

要求：必须配置 workspace.dir

输出：<workspace>/memory/YYYY-MM-DD-slug.md（默认为 ~/.openclaw/workspace）

作用：

1. 使用重置前的会话条目来定位正确的记录
2. 提取最后 15 行对话
3. 使用 LLM 生成描述性文件名片段
4. 将会话元数据保存到带日期的内存文件

输出示例：

# Session: 2026-01-16 14:30:00 UTC

- **Session Key**: agent:main:main
- **Session ID**: abc123def456
- **Source**: telegram

文件名示例：

• 2026-01-16-vendor-pitch.md
• 2026-01-16-api-design.md
• 2026-01-16-1430.md （如果 slug 生成失败则使用回退时间戳）

启用：

openclaw hooks enable session-memory

command-logger

将所有命令事件记录到中心审计文件中。

事件： command

要求：无

输出： ~/.openclaw/logs/commands.log

作用：

1. 捕获事件详细信息（命令操作、时间戳、会话密钥、发送者 ID、来源）
2. 以 JSONL 格式追加到日志文件
3. 在后台静默运行

示例日志条目：

{"timestamp":"2026-01-16T14:30:00.000Z","action":"new","sessionKey":"agent:main:main","senderId":"[phone]","source":"telegram"}
{"timestamp":"2026-01-16T15:45:22.000Z","action":"stop","sessionKey":"agent:main:main","senderId":"[e-mail]","source":"whatsapp"}

查看日志：

# View recent commands
tail -n 20 ~/.openclaw/logs/commands.log

# Pretty-print with jq
cat ~/.openclaw/logs/commands.log | jq .

# Filter by action
grep '"action":"new"' ~/.openclaw/logs/commands.log | jq .

启用：

openclaw hooks enable command-logger

soul-evil

在清除窗口期间或随机将注入的 SOUL.md 内容与 SOUL_EVIL.md 交换。

事件： agent:bootstrap

文档： SOUL Evil Hook

输出：不写入文件；交换仅在内存中进行。

启用：

openclaw hooks enable soul-evil

配置：

{
  "hooks": {
    "internal": {
      "enabled": true,
      "entries": {
        "soul-evil": {
          "enabled": true,
          "file": "SOUL_EVIL.md",
          "chance": 0.1,
          "purge": { "at": "21:00", "duration": "15m" }
        }
      }
    }
  }
}

boot-md

在网关启动时（通道启动之后）运行 BOOT.md。 必须启用内部 Hook 才能运行此功能。

事件： gateway:startup

要求：必须配置 workspace.dir

作用：

1. 从您的工作区读取 BOOT.md
2. 通过代理运行器运行指令
3. 通过消息工具发送任何请求的出站消息

启用：

openclaw hooks enable boot-md

最佳实践

保持处理程序快速

Hook 在命令处理期间运行。请保持轻量：

// ✓ Good - async work, returns immediately
const handler: HookHandler = async (event) => {
  void processInBackground(event); // Fire and forget
};

// ✗ Bad - blocks command processing
const handler: HookHandler = async (event) => {
  await slowDatabaseQuery(event);
  await evenSlowerAPICall(event);
};

优雅地处理错误

始终包装有风险的操作：

const handler: HookHandler = async (event) => {
  try {
    await riskyOperation(event);
  } catch (err) {
    console.error("[my-handler] Failed:", err instanceof Error ? err.message : String(err));
    // Don't throw - let other handlers run
  }
};

尽早过滤事件

如果事件不相关，请尽早返回：

const handler: HookHandler = async (event) => {
  // Only handle 'new' commands
  if (event.type !== "command" || event.action !== "new") {
    return;
  }

  // Your logic here
};

使用特定的事件键

尽可能在元数据中指定确切的事件：

metadata: { "openclaw": { "events": ["command:new"] } } # Specific

而不是：

metadata: { "openclaw": { "events": ["command"] } } # General - more overhead

调试

启用 Hook 日志记录

网关在启动时记录 Hook 加载情况：

Registered hook: session-memory -> command:new
Registered hook: command-logger -> command
Registered hook: boot-md -> gateway:startup

检查设备发现

列出所有已发现的 Hook：

openclaw hooks list --verbose

检查注册

在您的处理程序中，记录调用时间：

const handler: HookHandler = async (event) => {
  console.log("[my-handler] Triggered:", event.type, event.action);
  // Your logic
};

验证资格

检查 Hook 不符合资格的原因：

openclaw hooks info my-hook

查找输出中缺少的要求。

测试

Gateway 网关 日志

监控网关日志以查看 Hook 执行情况：

# macOS
./scripts/clawlog.sh -f

# Other platforms
tail -f ~/.openclaw/gateway.log

直接测试 Hooks

单独测试您的处理程序：

import { test } from "vitest";
import { createHookEvent } from "./src/hooks/hooks.js";
import myHandler from "./hooks/my-hook/handler.js";

test("my handler works", async () => {
  const event = createHookEvent("command", "new", "test-session", {
    foo: "bar",
  });

  await myHandler(event);

  // Assert side effects
});

架构

核心组件

• src/hooks/types.ts：类型定义
• src/hooks/workspace.ts：目录扫描与加载
• src/hooks/frontmatter.ts：HOOK.md 元数据解析
• src/hooks/config.ts：资格检查
• src/hooks/hooks-status.ts：状态报告
• src/hooks/loader.ts：动态模块加载器
• src/cli/hooks-cli.ts：CLI 命令
• src/gateway/server-startup.ts：在网关启动时加载 hooks
• src/auto-reply/reply/commands-core.ts：触发命令事件

设备发现流程

Gateway startup
    ↓
Scan directories (workspace → managed → bundled)
    ↓
Parse HOOK.md files
    ↓
Check eligibility (bins, env, config, os)
    ↓
Load handlers from eligible hooks
    ↓
Register handlers for events

事件流程

User sends /new
    ↓
Command validation
    ↓
Create hook event
    ↓
Trigger hook (all registered handlers)
    ↓
Command processing continues
    ↓
Session reset

故障排除

Hook 未被发现

1. 检查目录结构：

   ls -la ~/.openclaw/hooks/my-hook/
   # Should show: HOOK.md, handler.ts
   

2. 验证 HOOK.md 格式：

   cat ~/.openclaw/hooks/my-hook/HOOK.md
   # Should have YAML frontmatter with name and metadata
   

3. 列出所有已发现的 hooks：

   openclaw hooks list
   

Hook 不符合资格

检查要求：

openclaw hooks info my-hook

查找缺失项：

• 二进制文件（检查 PATH）
• 环境变量
• 配置值
• 操作系统兼容性

Hook 未执行

1. 验证 hook 是否已启用：

   openclaw hooks list
   # Should show ✓ next to enabled hooks
   

2. 重启您的网关进程以重新加载 hooks。

3. 检查网关日志中的错误：

   ./scripts/clawlog.sh | grep hook
   

处理程序错误

检查 TypeScript/导入错误：

# Test import directly
node -e "import('./path/to/handler.ts').then(console.log)"

迁移指南

从旧版配置到设备发现

之前：

{
  "hooks": {
    "internal": {
      "enabled": true,
      "handlers": [
        {
          "event": "command:new",
          "module": "./hooks/handlers/my-handler.ts"
        }
      ]
    }
  }
}

之后：

1. 创建 hook 目录：

   mkdir -p ~/.openclaw/hooks/my-hook
   mv ./hooks/handlers/my-handler.ts ~/.openclaw/hooks/my-hook/handler.ts
   

2. 创建 HOOK.md：

   ---
   name: my-hook
   description: "My custom hook"
   metadata: { "openclaw": { "emoji": "🎯", "events": ["command:new"] } }
   ---
   
   # My Hook
   
   Does something useful.
   

3. 更新配置：

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

4. 验证并重启您的网关进程：

   openclaw hooks list
   # Should show: 🎯 my-hook ✓
   

迁移的好处：

• 自动设备发现
• CLI 管理
• 资格检查
• 更完善的文档
• 统一的结构

另请参阅

• CLI 参考：hooks
• Bundled Hooks README
• Webhook Hooks
• 配置

---

本页面源自 openclaw/openclaw，由 BeaversLab 翻译，遵循 MIT 协议 发布。