메인 콘텐츠로 건너뛰기

Hooks

Hooks 는 에이전트 명령과 이벤트에 대응하여 작업을 자동화하기 위한 확장 가능한 이벤트 기반 시스템을 제공합니다. Hooks 는 디렉토리에서 자동으로 발견되며, OpenClaw 에서 skills 가 동작하는 방식과 유사하게 CLI 명령으로 관리할 수 있습니다.

Getting Oriented

Hooks 는 어떤 일이 발생할 때 실행되는 작은 스크립트입니다. 두 가지 종류가 있습니다:
  • Hooks (이 페이지): /new, /reset, /stop 과 같은 에이전트 이벤트나 라이프사이클 이벤트가 발생할 때 Gateway(게이트웨이) 내부에서 실행됩니다.
  • Webhooks: 외부 HTTP 웹훅으로, 다른 시스템이 OpenClaw 에서 작업을 트리거할 수 있도록 합니다. Webhook Hooks을 참고하거나 Gmail 헬퍼 명령에는 openclaw webhooks 을 사용하십시오.
Hooks 는 플러그인 내부에 번들로 포함될 수도 있습니다. 자세한 내용은 Plugins를 참고하십시오. 일반적인 사용 사례:
  • 세션을 리셋할 때 메모리 스냅샷 저장
  • 문제 해결이나 컴플라이언스를 위해 명령 감사 로그 유지
  • 세션 시작 또는 종료 시 후속 자동화 트리거
  • 이벤트 발생 시 에이전트 워크스페이스에 파일을 작성하거나 외부 API 호출
작은 TypeScript 함수를 작성할 수 있다면 hook 을 작성할 수 있습니다. Hooks 는 자동으로 발견되며, CLI 를 통해 활성화하거나 비활성화합니다.

개요

hooks 시스템을 통해 다음을 수행할 수 있습니다:
  • /new 이 실행될 때 세션 컨텍스트를 메모리에 저장
  • 감사를 위해 모든 명령을 기록합니다
  • 에이전트 라이프사이클 이벤트에 대한 사용자 정의 자동화 트리거
  • 코어 코드를 수정하지 않고 OpenClaw 동작 확장

시작하기

번들 hooks

OpenClaw 에는 자동으로 발견되는 네 가지 번들 hooks 가 포함되어 있습니다:
  • 💾 session-memory: /new 을 실행하면 세션 컨텍스트를 에이전트 워크스페이스(기본값 ~/.openclaw/workspace/memory/)에 저장합니다.
  • 😈 soul-evil: 퍼지 윈도우 동안 또는 무작위 확률로 주입된 SOUL.md 콘텐츠를 SOUL_EVIL.md 로 교체합니다.
  • 📝 command-logger: 모든 명령 이벤트를 ~/.openclaw/logs/commands.log 에 로깅합니다.
  • 🚀 boot-md: 게이트웨이가 시작될 때 BOOT.md 을 실행합니다(내부 hooks 활성화 필요).
사용 가능한 hooks 목록 보기:
openclaw hooks list
hook 활성화:
openclaw hooks enable session-memory
hook 상태 확인:
openclaw hooks check
상세 정보 보기:
openclaw hooks info session-memory

Onboarding

온보딩(openclaw onboard) 중에는 권장 hooks 를 활성화하라는 안내를 받게 됩니다. 마법사는 적합한 hooks 를 자동으로 발견하여 선택할 수 있도록 제시합니다.

Hook 발견

Hooks 는 다음 세 디렉토리에서 자동으로 발견됩니다(우선순위 순):
  1. 워크스페이스 hooks: <workspace>/hooks/ (에이전트별, 최우선)
  2. 관리형 hooks: ~/.openclaw/hooks/ (사용자 설치, 워크스페이스 간 공유)
  3. 번들 hooks: <openclaw>/dist/hooks/bundled/ (OpenClaw 와 함께 제공)
관리형 hook 디렉토리는 단일 hook 이거나 hook 팩(패키지 디렉토리)일 수 있습니다. 각 hook 은 다음을 포함하는 디렉토리입니다:
my-hook/
├── HOOK.md          # Metadata + documentation
└── handler.ts       # Handler implementation

Hook 팩 (npm/아카이브)

Hook 팩은 표준 npm 패키지로, package.json 에서 openclaw.hooks 을 통해 하나 이상의 hook 을 내보냅니다. 설치 방법:
openclaw hooks install <path-or-spec>
Npm 사양은 레지스트리 전용입니다 (패키지 이름 + 선택적 버전/태그). Git/URL/file 사양은 허용되지 않습니다. package.json 예시:
{
  "name": "@acme/my-hooks",
  "version": "0.1.0",
  "openclaw": {
    "hooks": ["./hooks/my-hook", "./hooks/other-hook"]
  }
}
각 항목은 HOOK.mdhandler.ts (또는 index.ts)를 포함하는 hook 디렉토리를 가리킵니다. Hook 팩은 의존성을 포함할 수 있으며, 이들은 ~/.openclaw/hooks/<id> 아래에 설치됩니다. 보안 참고: openclaw hooks installnpm install --ignore-scripts로 의존성을 설치합니다 (라이프사이클 스크립트 실행 없음). hook pack 의존성 트리는 “순수 JS/TS”로 유지하고 postinstall 빌드에 의존하는 패키지는 피하세요.

Hook 구조

HOOK.md 형식

HOOK.md 파일에는 YAML 프론트매터와 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: 사용할 named 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:startup: 채널이 시작되고 hooks 가 로드된 이후

도구 결과 hooks (Plugin API)

이 hooks 는 이벤트 스트림 리스너가 아닙니다. 플러그인이 OpenClaw 가 결과를 저장하기 전에 도구 결과를 동기적으로 조정할 수 있게 합니다.
  • tool_result_persist: 세션 트랜스크립트에 기록되기 전에 도구 결과를 변환합니다. 반드시 동기적이어야 하며, 업데이트된 도구 결과 페이로드를 반환하거나 그대로 유지하려면 undefined 을 반환하십시오. Agent Loop를 참고하십시오.

향후 이벤트

계획된 이벤트 유형:
  • session:start: 새 세션이 시작될 때
  • session:end: 세션이 종료될 때
  • agent:error: 에이전트가 오류를 만났을 때
  • message:sent: 메시지가 전송될 때
  • message:received: 메시지가 수신될 때

사용자 정의 Hooks 생성

1. 위치 선택

  • 워크스페이스 hooks (<workspace>/hooks/): 에이전트별, 최우선
  • 관리형 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 }
      }
    }
  }
}

Per-Hook Configuration

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"
        }
      ]
    }
  }
}
참고: module은 워크스페이스 기준 상대 경로여야 합니다. 절대 경로 및 워크스페이스 외부로의 경로 이동은 허용되지 않습니다. 마이그레이션: 새 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

번들 hook 참조

session-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 (슬러그 생성 실패 시 대체 타임스탬프)
활성화:
openclaw hooks enable session-memory

bootstrap-extra-files

agent:bootstrap 실행 중 추가 부트스트랩 파일(예: 모노레포 로컬 AGENTS.md / TOOLS.md)을 주입합니다. 이벤트: agent:bootstrap 문서: SOUL Evil Hook 출력: 파일은 기록되지 않으며, 교체는 메모리 내에서만 발생합니다. 설정:
{
  "hooks": {
    "internal": {
      "enabled": true,
      "entries": {
        "soul-evil": {
          "enabled": true,
          "file": "SOUL_EVIL.md",
          "chance": 0.1,
          "purge": { "at": "21:00", "duration": "15m" }
        }
      }
    }
  }
}
이전:
  • 경로는 워크스페이스 기준으로 해석됩니다.
  • 파일은 반드시 워크스페이스 내부에 있어야 합니다 (realpath 검사).
  • 인식된 부트스트랩 기본 이름만 로드됩니다.
  • 하위 에이전트 허용 목록은 유지됩니다 (AGENTS.mdTOOLS.md만).
활성화:
openclaw hooks enable bootstrap-extra-files

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":"+1234567890","source":"telegram"}
{"timestamp":"2026-01-16T15:45:22.000Z","action":"stop","sessionKey":"agent:main:main","senderId":"[email protected]","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

boot-md

게이트웨이가 시작될 때(채널 시작 이후) BOOT.md 을 실행합니다. 이를 실행하려면 내부 hooks 가 활성화되어 있어야 합니다. 이벤트: gateway:startup 요구 사항: workspace.dir 이 설정되어 있어야 합니다. 동작 방식:
  1. 워크스페이스에서 BOOT.md 을 읽습니다.
  2. 에이전트 러너를 통해 지침을 실행합니다.
  3. 메시지 도구를 통해 요청된 모든 아웃바운드 메시지를 전송합니다.
활성화:
openclaw hooks enable boot-md

모범 사례

핸들러를 빠르게 유지

Hooks 는 명령 처리 중에 실행됩니다. 가볍게 유지하십시오:
// ✓ 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

발견 확인

발견된 모든 hooks 나열:
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
Look for missing:
  • 바이너리(PATH 확인)
  • 환경 변수
  • 설정 값
  • OS 호환성

Hook 이 적합하지 않음

  1. hook 이 활성화되어 있는지 확인:
    openclaw hooks list
    # Should show ✓ next to enabled hooks
    
  2. hooks 가 다시 로드되도록 게이트웨이 프로세스를 재시작하십시오.
  3. 오류가 있는지 게이트웨이 로그를 확인하십시오:
    ./scripts/clawlog.sh | grep hook
    

핸들러 오류

TypeScript / import 오류를 확인하십시오:
# 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 관리
  • 적합성 검사
  • 더 나은 문서화
  • 일관된 구조

See Also