mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-12 06:13:43 +00:00
Docs: normalize zh-CN terminology + tone
What: switch to 你/你的 tone; standardize Skills/Gateway网关/local loopback/私信 wording Why: align zh-CN docs with issue 6995 feedback + idiomatic tech style Tests: pnpm docs:build
This commit is contained in:
@@ -15,13 +15,13 @@ x-i18n:
|
||||
|
||||
# 钩子
|
||||
|
||||
钩子提供了一个可扩展的事件驱动系统,用于在响应智能体命令和事件时自动执行操作。钩子从目录中自动发现,并可通过 CLI 命令管理,类似于 OpenClaw 中技能的工作方式。
|
||||
钩子提供了一个可扩展的事件驱动系统,用于在响应智能体命令和事件时自动执行操作。钩子从目录中自动发现,并可通过 CLI 命令管理,类似于 OpenClaw 中 Skills 的工作方式。
|
||||
|
||||
## 快速了解
|
||||
|
||||
钩子是在某些事件发生时运行的小脚本。有两种类型:
|
||||
|
||||
- **钩子**(本页):在智能体事件触发时在 Gateway 内部运行,如 `/new`、`/reset`、`/stop` 或生命周期事件。
|
||||
- **钩子**(本页):在智能体事件触发时在 Gateway网关内部运行,如 `/new`、`/reset`、`/stop` 或生命周期事件。
|
||||
- **Webhook**:外部 HTTP webhook,允许其他系统在 OpenClaw 中触发工作。参见 [Webhook 钩子](/automation/webhook) 或使用 `openclaw webhooks` 获取 Gmail 辅助命令。
|
||||
|
||||
钩子也可以捆绑在插件中;参见 [插件](/plugin#plugin-hooks)。
|
||||
@@ -52,7 +52,7 @@ OpenClaw 附带四个自动发现的内置钩子:
|
||||
|
||||
- **💾 session-memory**:在你发出 `/new` 时将会话上下文保存到智能体工作区(默认 `~/.openclaw/workspace/memory/`)
|
||||
- **📝 command-logger**:将所有命令事件记录到 `~/.openclaw/logs/commands.log`
|
||||
- **🚀 boot-md**:在 Gateway 启动时运行 `BOOT.md`(需要启用内部钩子)
|
||||
- **🚀 boot-md**:在 Gateway网关启动时运行 `BOOT.md`(需要启用内部钩子)
|
||||
- **😈 soul-evil**:在清除窗口期间或随机概率下,将注入的 `SOUL.md` 内容替换为 `SOUL_EVIL.md`
|
||||
|
||||
列出可用钩子:
|
||||
@@ -79,9 +79,9 @@ openclaw hooks check
|
||||
openclaw hooks info session-memory
|
||||
```
|
||||
|
||||
### 上手引导
|
||||
### 新手引导
|
||||
|
||||
在上手引导(`openclaw onboard`)期间,你会被提示启用推荐的钩子。向导会自动发现符合条件的钩子并展示供你选择。
|
||||
在新手引导(`openclaw onboard`)期间,你会被提示启用推荐的钩子。向导会自动发现符合条件的钩子并展示供你选择。
|
||||
|
||||
## 钩子发现
|
||||
|
||||
@@ -240,9 +240,9 @@ export default myHandler;
|
||||
|
||||
- **`agent:bootstrap`**:在工作区引导文件注入之前(钩子可以修改 `context.bootstrapFiles`)
|
||||
|
||||
### Gateway 事件
|
||||
### Gateway网关事件
|
||||
|
||||
在 Gateway 启动时触发:
|
||||
在 Gateway网关启动时触发:
|
||||
|
||||
- **`gateway:startup`**:在渠道启动和钩子加载之后
|
||||
|
||||
@@ -316,7 +316,7 @@ openclaw hooks list
|
||||
# 启用它
|
||||
openclaw hooks enable my-hook
|
||||
|
||||
# 重启你的 Gateway 进程(macOS 上重启菜单栏应用,或重启开发进程)
|
||||
# 重启你的 Gateway网关进程(macOS 上重启菜单栏应用,或重启开发进程)
|
||||
|
||||
# 触发事件
|
||||
# 通过消息渠道发送 /new
|
||||
@@ -571,7 +571,7 @@ openclaw hooks enable soul-evil
|
||||
|
||||
### boot-md
|
||||
|
||||
在 Gateway 启动时(渠道启动之后)运行 `BOOT.md`。
|
||||
在 Gateway网关启动时(渠道启动之后)运行 `BOOT.md`。
|
||||
必须启用内部钩子才能运行。
|
||||
|
||||
**事件**:`gateway:startup`
|
||||
@@ -657,7 +657,7 @@ metadata: { "openclaw": { "events": ["command"] } } # 通用 - 开销更大
|
||||
|
||||
### 启用钩子日志
|
||||
|
||||
Gateway 在启动时记录钩子加载情况:
|
||||
Gateway网关在启动时记录钩子加载情况:
|
||||
|
||||
```
|
||||
Registered hook: session-memory -> command:new
|
||||
@@ -696,9 +696,9 @@ openclaw hooks info my-hook
|
||||
|
||||
## 测试
|
||||
|
||||
### Gateway 日志
|
||||
### Gateway网关日志
|
||||
|
||||
监控 Gateway 日志以查看钩子执行情况:
|
||||
监控 Gateway网关日志以查看钩子执行情况:
|
||||
|
||||
```bash
|
||||
# macOS
|
||||
@@ -739,13 +739,13 @@ test("my handler works", async () => {
|
||||
- **`src/hooks/hooks-status.ts`**:状态报告
|
||||
- **`src/hooks/loader.ts`**:动态模块加载器
|
||||
- **`src/cli/hooks-cli.ts`**:CLI 命令
|
||||
- **`src/gateway/server-startup.ts`**:Gateway 启动时加载钩子
|
||||
- **`src/gateway/server-startup.ts`**:Gateway网关启动时加载钩子
|
||||
- **`src/auto-reply/reply/commands-core.ts`**:触发命令事件
|
||||
|
||||
### 发现流程
|
||||
|
||||
```
|
||||
Gateway 启动
|
||||
Gateway网关启动
|
||||
↓
|
||||
扫描目录(工作区 → 托管 → 内置)
|
||||
↓
|
||||
@@ -821,9 +821,9 @@ openclaw hooks info my-hook
|
||||
# 已启用的钩子旁边应显示 ✓
|
||||
```
|
||||
|
||||
2. 重启你的 Gateway 进程以重新加载钩子。
|
||||
2. 重启你的 Gateway网关进程以重新加载钩子。
|
||||
|
||||
3. 检查 Gateway 日志中的错误:
|
||||
3. 检查 Gateway网关日志中的错误:
|
||||
```bash
|
||||
./scripts/clawlog.sh | grep hook
|
||||
```
|
||||
@@ -897,7 +897,7 @@ node -e "import('./path/to/handler.ts').then(console.log)"
|
||||
}
|
||||
```
|
||||
|
||||
4. 验证并重启你的 Gateway 进程:
|
||||
4. 验证并重启你的 Gateway网关进程:
|
||||
```bash
|
||||
openclaw hooks list
|
||||
# 应该显示:🎯 my-hook ✓
|
||||
|
||||
Reference in New Issue
Block a user