Set up your first hook
To create a hook, add ahooks block to a settings file. This walkthrough creates a desktop notification hook, so you get alerted whenever Claude is waiting for your input instead of watching the terminal.
Add the hook to your settings
Open If your settings file already has a
~/.claude/settings.json and add a Notification hook. The example below uses osascript for macOS; see Get notified when Claude needs input for Linux and Windows commands.hooks key, merge the Notification entry into it rather than replacing the whole object. You can also ask Claude to write the hook for you by describing what you want in the CLI.Verify the configuration
Type
/hooks to open the hooks browser. You’ll see a list of all available hook events, with a count next to each event that has hooks configured. Select Notification to confirm your new hook appears in the list. Selecting the hook shows its details: the event, matcher, type, source file, and command.What you can automate
Hooks let you run code at key points in Claude Code’s lifecycle: format files after edits, block commands before they execute, send notifications when Claude needs input, inject context at session start, and more. For the full list of hook events, see the Hooks reference. Each example includes a ready-to-use configuration block that you add to a settings file. The most common patterns:- Get notified when Claude needs input
- Auto-format code after edits
- Block edits to protected files
- Re-inject context after compaction
- Audit configuration changes
- Auto-approve specific permission prompts
Get notified when Claude needs input
Get a desktop notification whenever Claude finishes working and needs your input, so you can switch to other tasks without checking the terminal. This hook uses theNotification event, which fires when Claude is waiting for input or permission. Each tab below uses the platform’s native notification command. Add this to ~/.claude/settings.json:
- macOS
- Linux
- Windows (PowerShell)
Auto-format code after edits
Automatically run Prettier on every file Claude edits, so formatting stays consistent without manual intervention. This hook uses thePostToolUse event with an Edit|Write matcher, so it runs only after file-editing tools. The command extracts the edited file path with jq and passes it to Prettier. Add this to .claude/settings.json in your project root:
The Bash examples on this page use
jq for JSON parsing. Install it with brew install jq (macOS), apt-get install jq (Debian/Ubuntu), or see jq downloads.Block edits to protected files
Prevent Claude from modifying sensitive files like.env, package-lock.json, or anything in .git/. Claude receives feedback explaining why the edit was blocked, so it can adjust its approach.
This example uses a separate script file that the hook calls. The script checks the target file path against a list of protected patterns and exits with code 2 to block the edit.
Make the script executable (macOS/Linux)
Hook scripts must be executable for Claude Code to run them:
Re-inject context after compaction
When Claude’s context window fills up, compaction summarizes the conversation to free space. This can lose important details. Use aSessionStart hook with a compact matcher to re-inject critical context after every compaction.
Any text your command writes to stdout is added to Claude’s context. This example reminds Claude of project conventions and recent work. Add this to .claude/settings.json in your project root:
echo with any command that produces dynamic output, like git log --oneline -5 to show recent commits. For injecting context on every session start, consider using CLAUDE.md instead. For environment variables, see CLAUDE_ENV_FILE in the reference.
Audit configuration changes
Track when settings or skills files change during a session. TheConfigChange event fires when an external process or editor modifies a configuration file, so you can log changes for compliance or block unauthorized modifications.
This example appends each change to an audit log. Add this to ~/.claude/settings.json:
user_settings, project_settings, local_settings, policy_settings, or skills. To block a change from taking effect, exit with code 2 or return {"decision": "block"}. See the ConfigChange reference for the full input schema.
Auto-approve specific permission prompts
Skip the approval dialog for tool calls you always allow. This example auto-approvesExitPlanMode, the tool Claude calls when it finishes presenting a plan and asks to proceed, so you aren’t prompted every time a plan is ready.
Unlike the exit-code examples above, auto-approval requires your hook to write a JSON decision to stdout. A PermissionRequest hook fires when Claude Code is about to show a permission dialog, and returning "behavior": "allow" answers it on your behalf.
The matcher scopes the hook to ExitPlanMode only, so no other prompts are affected. Add this to ~/.claude/settings.json:
updatedPermissions array with a setMode entry. The mode value is any permission mode like default, acceptEdits, or bypassPermissions, and destination: "session" applies it for the current session only.
To switch the session to acceptEdits, your hook writes this JSON to stdout:
.* or leaving the matcher empty would auto-approve every permission prompt, including file writes and shell commands. See the PermissionRequest reference for the full set of decision fields.
How hooks work
Hook events fire at specific lifecycle points in Claude Code. When an event fires, all matching hooks run in parallel, and identical hook commands are automatically deduplicated. The table below shows each event and when it triggers:| Event | When it fires |
|---|---|
SessionStart | When a session begins or resumes |
UserPromptSubmit | When you submit a prompt, before Claude processes it |
PreToolUse | Before a tool call executes. Can block it |
PermissionRequest | When a permission dialog appears |
PostToolUse | After a tool call succeeds |
PostToolUseFailure | After a tool call fails |
Notification | When Claude Code sends a notification |
SubagentStart | When a subagent is spawned |
SubagentStop | When a subagent finishes |
Stop | When Claude finishes responding |
TeammateIdle | When an agent team teammate is about to go idle |
TaskCompleted | When a task is being marked as completed |
InstructionsLoaded | When a CLAUDE.md or .claude/rules/*.md file is loaded into context. Fires at session start and when files are lazily loaded during a session |
ConfigChange | When a configuration file changes during a session |
WorktreeCreate | When a worktree is being created via --worktree or isolation: "worktree". Replaces default git behavior |
WorktreeRemove | When a worktree is being removed, either at session exit or when a subagent finishes |
PreCompact | Before context compaction |
PostCompact | After context compaction completes |
Elicitation | When an MCP server requests user input during a tool call |
ElicitationResult | After a user responds to an MCP elicitation, before the response is sent back to the server |
SessionEnd | When a session terminates |
type that determines how it runs. Most hooks use "type": "command", which runs a shell command. Three other types are available:
"type": "http": POST event data to a URL. See HTTP hooks."type": "prompt": single-turn LLM evaluation. See Prompt-based hooks."type": "agent": multi-turn verification with tool access. See Agent-based hooks.
Read input and return output
Hooks communicate with Claude Code through stdin, stdout, stderr, and exit codes. When an event fires, Claude Code passes event-specific data as JSON to your script’s stdin. Your script reads that data, does its work, and tells Claude Code what to do next via the exit code.Hook input
Every event includes common fields likesession_id and cwd, but each event type adds different data. For example, when Claude runs a Bash command, a PreToolUse hook receives something like this on stdin:
UserPromptSubmit hooks get the prompt text instead, SessionStart hooks get the source (startup, resume, clear, compact), and so on. See Common input fields in the reference for shared fields, and each event’s section for event-specific schemas.
Hook output
Your script tells Claude Code what to do next by writing to stdout or stderr and exiting with a specific code. For example, aPreToolUse hook that wants to block a command:
- Exit 0: the action proceeds. For
UserPromptSubmitandSessionStarthooks, anything you write to stdout is added to Claude’s context. - Exit 2: the action is blocked. Write a reason to stderr, and Claude receives it as feedback so it can adjust.
- Any other exit code: the action proceeds. Stderr is logged but not shown to Claude. Toggle verbose mode with
Ctrl+Oto see these messages in the transcript.
Structured JSON output
Exit codes give you two options: allow or block. For more control, exit 0 and print a JSON object to stdout instead.Use exit 2 to block with a stderr message, or exit 0 with JSON for structured control. Don’t mix them: Claude Code ignores JSON when you exit 2.
PreToolUse hook can deny a tool call and tell Claude why, or escalate it to the user for approval:
permissionDecision and cancels the tool call, then feeds permissionDecisionReason back to Claude as feedback. These three options are specific to PreToolUse:
"allow": proceed without showing a permission prompt"deny": cancel the tool call and send the reason to Claude"ask": show the permission prompt to the user as normal
PostToolUse and Stop hooks use a top-level decision: "block" field, while PermissionRequest uses hookSpecificOutput.decision.behavior. See the summary table in the reference for a full breakdown by event.
For UserPromptSubmit hooks, use additionalContext instead to inject text into Claude’s context. Prompt-based hooks (type: "prompt") handle output differently: see Prompt-based hooks.
Filter hooks with matchers
Without a matcher, a hook fires on every occurrence of its event. Matchers let you narrow that down. For example, if you want to run a formatter only after file edits (not after every tool call), add a matcher to yourPostToolUse hook:
"Edit|Write" matcher is a regex pattern that matches the tool name. The hook only fires when Claude uses the Edit or Write tool, not when it uses Bash, Read, or any other tool.
Each event type matches on a specific field. Matchers support exact strings and regex patterns:
| Event | What the matcher filters | Example matcher values |
|---|---|---|
PreToolUse, PostToolUse, PostToolUseFailure, PermissionRequest | tool name | Bash, Edit|Write, mcp__.* |
SessionStart | how the session started | startup, resume, clear, compact |
SessionEnd | why the session ended | clear, logout, prompt_input_exit, bypass_permissions_disabled, other |
Notification | notification type | permission_prompt, idle_prompt, auth_success, elicitation_dialog |
SubagentStart | agent type | Bash, Explore, Plan, or custom agent names |
PreCompact | what triggered compaction | manual, auto |
SubagentStop | agent type | same values as SubagentStart |
ConfigChange | configuration source | user_settings, project_settings, local_settings, policy_settings, skills |
UserPromptSubmit, Stop, TeammateIdle, TaskCompleted, WorktreeCreate, WorktreeRemove | no matcher support | always fires on every occurrence |
- Log every Bash command
- Match MCP tools
- Clean up on session end
Match only
Bash tool calls and log each command to a file. The PostToolUse event fires after the command completes, so tool_input.command contains what ran. The hook receives the event data as JSON on stdin, and jq -r '.tool_input.command' extracts just the command string, which >> appends to the log file:Configure hook location
Where you add a hook determines its scope:| Location | Scope | Shareable |
|---|---|---|
~/.claude/settings.json | All your projects | No, local to your machine |
.claude/settings.json | Single project | Yes, can be committed to the repo |
.claude/settings.local.json | Single project | No, gitignored |
| Managed policy settings | Organization-wide | Yes, admin-controlled |
Plugin hooks/hooks.json | When plugin is enabled | Yes, bundled with the plugin |
| Skill or agent frontmatter | While the skill or agent is active | Yes, defined in the component file |
/hooks in Claude Code to browse all configured hooks grouped by event. To disable all hooks at once, set "disableAllHooks": true in your settings file.
If you edit settings files directly while Claude Code is running, the file watcher normally picks up hook changes automatically.
Prompt-based hooks
For decisions that require judgment rather than deterministic rules, usetype: "prompt" hooks. Instead of running a shell command, Claude Code sends your prompt and the hook’s input data to a Claude model (Haiku by default) to make the decision. You can specify a different model with the model field if you need more capability.
The model’s only job is to return a yes/no decision as JSON:
"ok": true: the action proceeds"ok": false: the action is blocked. The model’s"reason"is fed back to Claude so it can adjust.
Stop hook to ask the model whether all requested tasks are complete. If the model returns "ok": false, Claude keeps working and uses the reason as its next instruction:
Agent-based hooks
When verification requires inspecting files or running commands, usetype: "agent" hooks. Unlike prompt hooks which make a single LLM call, agent hooks spawn a subagent that can read files, search code, and use other tools to verify conditions before returning a decision.
Agent hooks use the same "ok" / "reason" response format as prompt hooks, but with a longer default timeout of 60 seconds and up to 50 tool-use turns.
This example verifies that tests pass before allowing Claude to stop:
HTTP hooks
Usetype: "http" hooks to POST event data to an HTTP endpoint instead of running a shell command. The endpoint receives the same JSON that a command hook would receive on stdin, and returns results through the HTTP response body using the same JSON format.
HTTP hooks are useful when you want a web server, cloud function, or external service to handle hook logic: for example, a shared audit service that logs tool use events across a team.
This example posts every tool use to a local logging service:
hookSpecificOutput fields. HTTP status codes alone cannot block actions.
Header values support environment variable interpolation using $VAR_NAME or ${VAR_NAME} syntax. Only variables listed in the allowedEnvVars array are resolved; all other $VAR references remain empty.
For full configuration options and response handling, see HTTP hooks in the reference.
Limitations and troubleshooting
Limitations
- Command hooks communicate through stdout, stderr, and exit codes only. They cannot trigger commands or tool calls directly. HTTP hooks communicate through the response body instead.
- Hook timeout is 10 minutes by default, configurable per hook with the
timeoutfield (in seconds). PostToolUsehooks cannot undo actions since the tool has already executed.PermissionRequesthooks do not fire in non-interactive mode (-p). UsePreToolUsehooks for automated permission decisions.Stophooks fire whenever Claude finishes responding, not only at task completion. They do not fire on user interrupts.
Hook not firing
The hook is configured but never executes.- Run
/hooksand confirm the hook appears under the correct event - Check that the matcher pattern matches the tool name exactly (matchers are case-sensitive)
- Verify you’re triggering the right event type (e.g.,
PreToolUsefires before tool execution,PostToolUsefires after) - If using
PermissionRequesthooks in non-interactive mode (-p), switch toPreToolUseinstead
Hook error in output
You see a message like “PreToolUse hook error: …” in the transcript.- Your script exited with a non-zero code unexpectedly. Test it manually by piping sample JSON:
- If you see “command not found”, use absolute paths or
$CLAUDE_PROJECT_DIRto reference scripts - If you see “jq: command not found”, install
jqor use Python/Node.js for JSON parsing - If the script isn’t running at all, make it executable:
chmod +x ./my-hook.sh
/hooks shows no hooks configured
You edited a settings file but the hooks don’t appear in the menu.
- File edits are normally picked up automatically. If they haven’t appeared after a few seconds, the file watcher may have missed the change: restart your session to force a reload.
- Verify your JSON is valid (trailing commas and comments are not allowed)
- Confirm the settings file is in the correct location:
.claude/settings.jsonfor project hooks,~/.claude/settings.jsonfor global hooks
Stop hook runs forever
Claude keeps working in an infinite loop instead of stopping. Your Stop hook script needs to check whether it already triggered a continuation. Parse thestop_hook_active field from the JSON input and exit early if it’s true:
JSON validation failed
Claude Code shows a JSON parsing error even though your hook script outputs valid JSON. When Claude Code runs a hook, it spawns a shell that sources your profile (~/.zshrc or ~/.bashrc). If your profile contains unconditional echo statements, that output gets prepended to your hook’s JSON:
$- variable contains shell flags, and i means interactive. Hooks run in non-interactive shells, so the echo is skipped.
Debug techniques
Toggle verbose mode withCtrl+O to see hook output in the transcript, or run claude --debug for full execution details including which hooks matched and their exit codes.
Learn more
- Hooks reference: full event schemas, JSON output format, async hooks, and MCP tool hooks
- Security considerations: review before deploying hooks in shared or production environments
- Bash command validator example: complete reference implementation