Hook Configuration

Complete reference for configuring validation hooks in han-plugin.yml, including commands, conditions, and caching.

Hooks are the heart of validation and tool plugins, enabling automatic validation at key points during Claude Code sessions. This guide covers everything you need to know about configuring hooks.

Hook Configuration File

Hooks are defined in han-plugin.yml at your plugin's root:

# my-plugin/han-plugin.yml
hooks:
  hook-name:
    command: "your-validation-command"
    dirs_with:
      - "config-file.json"
    if_changed:
      - "**/*.{js,ts}"

Basic Hook Structure

Each hook has a unique name and configuration:

hooks:
  lint:
    command: "npx eslint ${HAN_FILES}"
    dirs_with:
      - ".eslintrc.js"
      - ".eslintrc.json"
      - "eslint.config.js"
    if_changed:
      - "**/*.{js,jsx,ts,tsx}"

Configuration Options

command (required)

The shell command to execute. Use ${HAN_FILES} for session-scoped file targeting:

hooks:
  lint:
    # Without HAN_FILES - runs on all files
    command: "npx eslint ."

  lint-targeted:
    # With HAN_FILES - runs only on session-modified files
    command: "npx eslint ${HAN_FILES}"

How ${HAN_FILES} works:

Han tracks which files the current session modified
Files are filtered against if_changed patterns
Matching files are passed to the command
If no files match, ${HAN_FILES} becomes . (full directory)

dirs_with (optional)

Only run the hook in directories containing these files:

hooks:
  typecheck:
    command: "npx tsc --noEmit"
    dirs_with:
      - "tsconfig.json"

Multiple conditions (any match triggers):

hooks:
  lint:
    command: "npx biome check ."
    dirs_with:
      - "biome.json"
      - "biome.jsonc"

This is useful for:

Tools that require configuration files
Monorepos where tools only apply to certain packages
Optional validations that should only run when configured

if_changed (optional)

Only run when files matching these patterns changed:

hooks:
  test:
    command: "npm test"
    if_changed:
      - "**/*.ts"
      - "**/*.test.ts"
      - "**/__tests__/**"

Pattern syntax follows glob conventions:

* - Match any characters except /
** - Match any characters including /
? - Match single character
{a,b} - Match either a or b
[abc] - Match any character in set

timeout (optional)

Maximum execution time in seconds (default: 120):

hooks:
  test:
    command: "npm test"
    timeout: 300  # 5 minutes for slow tests

enabled (optional)

Disable a hook without removing it:

hooks:
  experimental:
    command: "my-experimental-check"
    enabled: false  # Won't run

Hook Lifecycle

Hooks run at specific points during Claude Code sessions:

Event	When	Best For
`SessionStart`	Session begins	Initialization
`UserPromptSubmit`	Before processing input	Pre-process, inject context
`PreToolUse`	Before tool execution	Input validation
`PermissionRequest`	Permission dialog appears (~2.1.50+)	Audit/auto-approve permissions
`PostToolUse`	After tool execution	Result processing
`PostToolUseFailure`	Tool execution fails (~2.1.50+)	Error tracking, recovery
`Stop`	Before response completes	Main validation point
`SubagentStop`	Subagent completes	Validate agent work
`Notification`	Notification event	Custom notification handling
`PreCompact`	Before context compaction (~2.1.50+)	Save state before compaction
`SessionEnd`	Session ends	Cleanup
`ConfigChange`	Configuration modified (2.1.49+)	Audit trails, config monitoring
`TeammateIdle`	Teammate goes idle (2.1.33+)	Team coordination
`TaskCompleted`	Task completed (2.1.33+)	Task tracking, workflows
`WorktreeCreate`	Worktree created (2.1.50+)	Agent isolation tracking, custom VCS
`WorktreeRemove`	Worktree removed (2.1.50+)	Cleanup automation

By default, validation and tool plugin hooks run at Stop and SubagentStop. Claude Code executes plugin hooks directly - you just define what to run.

New Hook Events (Claude Code 2.1.33+)

Several hook events have been added for permission auditing, error tracking, team workflows, and operational monitoring:

PermissionRequest (~2.1.50+)

Fired when a permission dialog appears. Supports matcher on tool name. Input includes permission_suggestions array. Can respond with behavior (allow/deny), updatedInput, updatedPermissions, message, or interrupt:

{
  "hook_event_name": "PermissionRequest",
  "session_id": "abc123",
  "cwd": "/project/path",
  "tool_name": "Bash",
  "permission_suggestions": [...]
}

PostToolUseFailure (~2.1.50+)

Fired when a tool execution fails. Input includes error string and is_interrupt boolean. Can return additionalContext to help Claude recover:

{
  "hook_event_name": "PostToolUseFailure",
  "session_id": "abc123",
  "cwd": "/project/path",
  "tool_name": "Bash",
  "error": "Command exited with code 1",
  "is_interrupt": false
}

PreCompact (~2.1.50+)

Fired before context compaction. Supports matcher for manual vs auto compaction:

{
  "hook_event_name": "PreCompact",
  "session_id": "abc123",
  "cwd": "/project/path"
}

ConfigChange (2.1.49+)

Fired when Claude Code configuration is modified. Useful for audit trails, configuration drift detection, and enforcing settings policies:

{
  "hook_event_name": "ConfigChange",
  "session_id": "abc123",
  "cwd": "/project/path"
}

TeammateIdle (2.1.33+)

Fired when a teammate agent goes idle between turns in multi-agent sessions. Enables team coordination, load balancing, and monitoring agent activity:

{
  "hook_event_name": "TeammateIdle",
  "session_id": "abc123",
  "cwd": "/project/path"
}

TaskCompleted (2.1.33+)

Fired when a task is marked as completed via TaskUpdate. Useful for task tracking dashboards, triggering follow-up workflows, and team notifications:

{
  "hook_event_name": "TaskCompleted",
  "session_id": "abc123",
  "cwd": "/project/path"
}

WorktreeCreate (2.1.50+)

Fired when a worktree is being created via --worktree flag or isolation: "worktree" in an agent definition. When configured, replaces default git worktree behavior — enabling non-git VCS support (SVN, Perforce, Mercurial).

The hook receives a name slug and must print the absolute path to the created worktree directory on stdout. Non-zero exit blocks creation. Only type: "command" hooks supported; no matchers.

{
  "hook_event_name": "WorktreeCreate",
  "session_id": "abc123",
  "cwd": "/project/path",
  "name": "feature-auth"
}

WorktreeRemove (2.1.50+)

Fired when a worktree is being removed. Receives the worktree_path that was originally created. Cannot block removal — failures are logged in debug mode only. Only type: "command" hooks supported; no matchers.

{
  "hook_event_name": "WorktreeRemove",
  "session_id": "abc123",
  "cwd": "/project/path",
  "worktree_path": "/project/.claude/worktrees/feature-auth"
}

Stop/SubagentStop: `last_assistant_message` (2.1.47+)

The Stop and SubagentStop hook inputs include a last_assistant_message field containing the final assistant message text. This allows hooks to inspect what the agent is about to respond with and take action based on the content:

{
  "hook_event_name": "Stop",
  "session_id": "abc123",
  "cwd": "/project/path",
  "last_assistant_message": "I've completed the refactoring of the auth module..."
}

This is useful for content-aware validation, sentiment analysis, or logging the agent's final output.

Smart Behaviors

Han hooks include intelligent features enabled by default:

Caching

Hooks skip when:

No files changed since last run
File hashes match previous execution
Command and configuration unchanged

This dramatically speeds up repeated validations.

Checkpoint Filtering

Hooks only validate your work:

Session hooks filter to session changes
Subagent hooks filter to subagent changes
Pre-existing issues are ignored

Fail-Fast

By default, hooks stop on first failure:

Get feedback immediately
Don't waste time on subsequent hooks
Fix issues one at a time

Complete Examples

Linter Hook

hooks:
  lint:
    command: "npx eslint ${HAN_FILES} --fix"
    dirs_with:
      - ".eslintrc.js"
      - ".eslintrc.json"
      - "eslint.config.js"
    if_changed:
      - "**/*.{js,jsx,ts,tsx}"

Type Checker Hook

hooks:
  typecheck:
    command: "npx tsc --noEmit"
    dirs_with:
      - "tsconfig.json"
    if_changed:
      - "**/*.{ts,tsx,mts,cts}"
      - "tsconfig*.json"

Test Runner Hook

hooks:
  test:
    command: "npm test"
    timeout: 300
    if_changed:
      - "**/*.ts"
      - "**/*.test.ts"
      - "**/__tests__/**"

Formatter Hook

hooks:
  format:
    command: "npx prettier --write ${HAN_FILES}"
    dirs_with:
      - ".prettierrc"
      - ".prettierrc.json"
      - "prettier.config.js"
    if_changed:
      - "**/*.{js,jsx,ts,tsx,json,md}"

Build Hook

hooks:
  build:
    command: "npm run build"
    timeout: 180
    dirs_with:
      - "package.json"
    if_changed:
      - "src/**/*.{ts,tsx}"
      - "package.json"

Multiple Hooks

A plugin can define multiple hooks:

hooks:
  lint:
    command: "npx biome check --write ${HAN_FILES}"
    dirs_with:
      - "biome.json"
    if_changed:
      - "**/*.{js,jsx,ts,tsx}"

  typecheck:
    command: "npx tsc --noEmit"
    dirs_with:
      - "tsconfig.json"
    if_changed:
      - "**/*.{ts,tsx}"

  test:
    command: "npm test"
    timeout: 300
    if_changed:
      - "**/*.ts"
      - "**/*.test.ts"

Environment Variables

Hooks have access to these environment variables:

Variable	Description
`CLAUDE_SESSION_ID`	Current session ID
`CLAUDE_PROJECT_ROOT`	Project root directory
`CLAUDE_PLUGIN_ROOT`	Plugin installation directory
`HAN_SESSION_ID`	Session ID (alias)

Use plugin root for relative paths:

hooks:
  validate:
    command: "bash ${CLAUDE_PLUGIN_ROOT}/scripts/validate.sh"

Hook Scripts

For complex validation logic, use shell scripts:

han-plugin.yml:

hooks:
  validate:
    command: "bash ${CLAUDE_PLUGIN_ROOT}/scripts/validate.sh"
    dirs_with:
      - "my-config.json"

scripts/validate.sh:

#!/usr/bin/env bash
set -e

# Complex validation logic here
echo "Running validation..."

# Check for specific conditions
if [ -f "my-config.json" ]; then
  npx my-validator check .
fi

# Exit 0 on success, non-zero on failure
exit 0

Best Practices

Use ${HAN_FILES} when possible - Enables session-scoped validation and better caching
Always specify dirs_with - Prevents hooks from running in unrelated directories
Be specific with if_changed - Only trigger on relevant file types
Set appropriate timeouts - Don't let slow commands block the workflow
Make commands idempotent - Running twice should produce the same result
Handle errors gracefully - Exit with non-zero status on failure, provide clear error messages

Prefer npx/bunx - Ensures tools are available without global installation:

hooks:
  lint:
    # Good - works without global install
    command: "npx eslint ."

    # Avoid - requires global installation
    # command: "eslint ."

Debugging Hooks

Test hooks manually:

# Run a specific hook
han hook run my-plugin lint

# Run with verbose output
han hook run my-plugin lint --verbose

# Run without caching
han hook run my-plugin lint --no-cache

Next Steps

Skills and Commands - Creating skills and commands
Testing Plugins - Local testing workflow
Distribution - Sharing your plugins