Hook System
Hook System
PAI 5.0 — Stable event-driven automation infrastructure.
Event-Driven Automation Infrastructure
Location: ~/.claude/hooks/
Configuration: ~/.claude/settings.json
Status: Active — hook count auto-computed by UpdateCounts.ts at session end
Overview
The PAI hook system is an event-driven automation infrastructure built on Claude Code’s native hook support. Hooks are executable scripts (TypeScript/Python) that run automatically in response to specific events during Claude Code sessions.
Core Capabilities:
- Session Management - Auto-load context, capture summaries, manage state
- Voice Notifications - Text-to-speech announcements for task completions
- History Capture - Automatic work/learning documentation to
~/.claude/PAI/MEMORY/ - Security Validation - Active (v4.0) — Inspector Pipeline: SecurityPipeline (PreToolUse), ContentScanner (PostToolUse), SmartApprover (PermissionRequest), PromptGuard (UserPromptSubmit). See
DOCUMENTATION/Security/SecuritySystem.md - Multi-Agent Support - Agent-specific hooks with voice routing
- Tab Titles - Dynamic terminal tab updates with task context
- Unified Event Stream - All hooks emit structured events to
events.jsonlfor real-time observability
Key Principle: Most hooks run asynchronously and fail gracefully. Security hooks (SecurityPipeline) are synchronous and blocking — they can prevent tool execution via exit(2). All .ts hooks have #!/usr/bin/env bun shebangs and +x permissions — settings.json references them directly (e.g., $HOME/.claude/hooks/SecurityPipeline.hook.ts) without a bun prefix. HTTP hooks (SkillGuard, AgentGuard) run via Pulse routes on localhost:31337.
Freshness Authority: When adding or modifying hooks, consult the claude-code-guide agent to verify current hook event types, return value schemas, and available fields.
Available Hook Types
Claude Code supports the following hook events:
1. SessionStart
When: Claude Code session begins (new conversation) Use Cases:
- Load PAI context (CLAUDE.md auto-loads routing + identity + PRINCIPAL_TELOS via @-imports)
- Initialize session state
- Capture session metadata
Current Hooks:
{
"SessionStart": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/KittyEnvPersist.hook.ts"
},
{
"type": "command",
"command": "$HOME/.claude/hooks/LoadContext.hook.ts"
},
{
"type": "command",
"command": "$HOME/.claude/hooks/KVSync.hook.ts",
"timeout": 10,
"async": true
}
]
}
]
}
What They Do:
KittyEnvPersist.hook.ts- Persists Kitty terminal env vars both to the sharedMEMORY/STATE/kitty-env.jsonand to a per-sessionMEMORY/STATE/kitty-sessions/{sessionId}.json(required by out-of-process consumers like Pulse voice daemon), then resets tab title to clean stateLoadContext.hook.ts- Injects dynamic context (relationship, learning, work summary) as<system-reminder>at session startKVSync.hook.ts- Pushes work.json to Cloudflare KV (sync:work_state) so admin.example.com activity dashboard has fresh data
2. SessionEnd
When: Claude Code session terminates (conversation ends) Use Cases:
- Capture work completions and learning moments
- Generate session summaries
- Record relationship context
- Update system counts (skills, hooks, signals)
- Run integrity checks
Current Hooks:
{
"SessionEnd": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/WorkCompletionLearning.hook.ts"
},
{
"type": "command",
"command": "$HOME/.claude/hooks/ULWorkSync.hook.ts"
},
{
"type": "command",
"command": "$HOME/.claude/hooks/SessionCleanup.hook.ts"
},
{
"type": "command",
"command": "$HOME/.claude/hooks/RelationshipMemory.hook.ts"
},
{
"type": "command",
"command": "$HOME/.claude/hooks/UpdateCounts.hook.ts"
},
{
"type": "command",
"command": "$HOME/.claude/hooks/IntegrityCheck.hook.ts"
},
{
"type": "command",
"command": "$HOME/.claude/hooks/KVSync.hook.ts"
}
]
}
]
}
What They Do:
WorkCompletionLearning.hook.ts- Reads PRD.md frontmatter for work metadata and ISC section for criteria status, captures learning toMEMORY/LEARNING/for significant work sessionsULWorkSync.hook.ts- Syncs UL work state at session endSessionCleanup.hook.ts- Marks PRD.md frontmatter status→COMPLETED and sets completed_at timestamp, clears session state, resets tab, cleans session namesRelationshipMemory.hook.ts- Captures relationship context (observations, behaviors) toMEMORY/RELATIONSHIP/UpdateCounts.hook.ts- Updates system counts (skills, hooks, signals, workflows, files) displayed in the startup bannerIntegrityCheck.hook.ts- Runs DocCrossRefIntegrity and SystemIntegrity checks at session endKVSync.hook.ts- Pushes work.json to Cloudflare KV so admin.example.com dashboard reflects final session state
3. UserPromptSubmit
When: User submits a new prompt to Claude Use Cases:
- Update UI indicators
- Pre-process user input
- Capture prompts for analysis
- Detect ratings and sentiment
Current Hooks:
{
"UserPromptSubmit": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/SessionAnalysis.hook.ts"
}
]
},
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/SatisfactionCapture.hook.ts"
}
]
},
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/PromptGuard.hook.ts"
}
]
}
]
}
What It Does:
SessionAnalysis.hook.ts - Unified Prompt Analysis (Rating + Tab + Naming)
- Consolidated replacement for the former RatingCapture + UpdateTabTitle + SessionAutoName (3 hooks → 1)
- One process, one inference call, three outputs — saves 1-2 Haiku API calls per user message
- Fast paths (no inference): explicit ratings (“8 - great”), positive praise (“nice work”), system text
- Deterministic tab title set immediately (purple/thinking state)
- Deterministic session name on first prompt (background Sonnet upgrade follows)
- Single Haiku inference returns: sentiment rating, tab title, session name
- Sets tab to orange/working state with inferred title + voice announcement
- Low ratings (<5) auto-capture as learning opportunities
- Writes to:
ratings.jsonl,session-names.json,work.json, tab state, voice server - Inference:
import { inference } from '../../.claude/PAI/TOOLS/Inference'→inference({ level: 'fast', expectJson: true }) - Performance: Fast paths <50ms, inference path ~1-1.5s
- Naming-context isolation (2026-04-19):
getRecentContext()strips Assistant turns whenisFirstPromptis true. Session names are permanent (one-shot, customTitle-promoted), so Algorithm scaffolding in assistant output — phase headers, agent names, SUMMARY lines — must never reach the naming prompt. Prior sessions like “Review Entering Yet Forge” and “Research Something Status” were caused by this leak. Tab-title context on follow-up prompts still includes Assistant turns.
SatisfactionCapture.hook.ts - Captures user satisfaction signals from prompt content for analytics and learning.
PromptGuard.hook.ts - Security: PromptInspector-based scan on user prompts. Part of the v4.0 Inspector Pipeline. Heuristic-only (no LLM) detection of injection, exfiltration, evasion, and security disable attempts.
Migration note: The old hooks (RatingCapture, UpdateTabTitle, SessionAutoName) remain on disk as reference but are no longer wired in settings.json.
4. Stop
When: Main agent ({DA_IDENTITY.NAME}) completes a response Use Cases:
- Voice notifications for task completion
- Capture work summaries and learnings
- Update terminal tab with final state (color + suffix based on outcome)
Current Hooks:
{
"Stop": [
{
"hooks": [
{ "type": "command", "command": "$HOME/.claude/hooks/LastResponseCache.hook.ts" },
{ "type": "command", "command": "$HOME/.claude/hooks/ResponseTabReset.hook.ts" },
{ "type": "command", "command": "$HOME/.claude/hooks/VoiceCompletion.hook.ts" },
{ "type": "command", "command": "$HOME/.claude/hooks/DocIntegrity.hook.ts" }
]
}
]
}
What They Do:
Each Stop hook is a self-contained .hook.ts file that reads stdin via shared hooks/lib/hook-io.ts, calls its handler, and exits. Handlers in hooks/handlers/ are unchanged — each hook is a thin wrapper.
LastResponseCache.hook.ts — Cache last response for SessionAnalysis bridge
- Writes
last_assistant_message(or transcript fallback) toMEMORY/STATE/last-response.txt - SessionAnalysis reads this on the next UserPromptSubmit to access the previous response
ResponseTabReset.hook.ts — Reset Kitty tab title/color after response
- Calls
handlers/TabState.tsto set completed state - Converts working gerund title to past tense
VoiceCompletion.hook.ts — Send 🗣️ voice line to TTS server
- Calls
handlers/VoiceNotification.tsfor voice delivery - Voice gate: only main sessions (checks
kitty-sessions/{sessionId}.json) - Subagents have no kitty-sessions file → voice blocked
DocIntegrity.hook.ts — Cross-reference + semantic drift checks + architecture summary regen
- Calls
handlers/DocCrossRefIntegrity.ts— deterministic + inference-powered doc updates - Calls
handlers/RebuildArchSummary.ts— regeneratesPAI_ARCHITECTURE_SUMMARY.mdwhen system files change - Self-gating: returns instantly when no system files were modified
Tab State System: See TERMINALTABS.md for complete documentation
5. PreToolUse
When: Before Claude executes any tool Use Cases:
- Voice curl gating (prevent background agents from speaking)
- Security validation across file operations (Bash, Edit, Write, Read, MultiEdit) — SecurityPipeline (Pattern → Egress → Rules inspectors) blocks dangerous commands, protects credentials, enforces path tiers
- Tab state updates on questions
- Agent execution guardrails — Pulse HTTP route at localhost:31337/hooks/agent-guard
- Skill invocation validation — Pulse HTTP route at localhost:31337/hooks/skill-guard
Current Hooks:
{
"PreToolUse": [
{
"matcher": "Bash",
"hooks": [
{ "type": "command", "command": "$HOME/.claude/hooks/SecurityPipeline.hook.ts" },
{ "type": "command", "command": "$HOME/.claude/hooks/ContextReduction.hook.sh" }
]
},
{
"matcher": "Write|Edit|MultiEdit|Read",
"hooks": [
{ "type": "command", "command": "$HOME/.claude/hooks/SecurityPipeline.hook.ts" }
]
},
{
"matcher": "Skill",
"hooks": [
{ "type": "http", "url": "http://localhost:31337/hooks/skill-guard" }
]
},
{
"matcher": "Agent",
"hooks": [
{ "type": "http", "url": "http://localhost:31337/hooks/agent-guard" }
]
},
{
"matcher": "AskUserQuestion",
"hooks": [
{ "type": "command", "command": "$HOME/.claude/hooks/SetQuestionTab.hook.ts" }
]
}
]
}
Security hooks (active, v4.0 Inspector Pipeline): SecurityPipeline runs on Bash/Write/Edit/MultiEdit matchers (composable inspector chain: PatternInspector(100) → EgressInspector(90); RulesInspector(50) disabled — empty SECURITY_RULES.md; exit(2) hard-block). ContentScanner runs on PostToolUse WebFetch/WebSearch matchers (InjectionInspector for prompt injection detection in external content). SmartApprover runs on PermissionRequest (trusted workspace auto-approval + read/write classification). PromptGuard runs on UserPromptSubmit (PromptInspector(95) — heuristic-only injection/exfiltration/evasion/security-disable detection, no LLM). SkillGuard and AgentGuard run via Pulse HTTP routes (localhost:31337). AgentGuard also injects a Monitor watchdog reminder for background agents (run_in_background: true) — Tools/AgentWatchdog.ts monitors tool-activity.jsonl for silence and alerts when agents may be hung. Inspector core: hooks/security/{types,pipeline,logger}.ts, inspectors: hooks/security/inspectors/. See DOCUMENTATION/Security/SecuritySystem.md for full architecture.
What They Do:
ContextReduction.hook.sh- Context reduction via RTK. Transparently rewrites Bash commands tortkequivalents for 60-90% token reduction across git, build, test, lint, and package manager output. Runs on the Bash matcher. Meta commands (use directly, not through hook):rtk gain(savings analytics),rtk gain --history(command history),rtk discover(missed opportunities),rtk proxy <cmd>(bypass filtering). Note: ifrtk gainfails, check for name collision with reachingforthejack/rtk (Rust Type Kit).SetQuestionTab.hook.ts- Updates tab state to “awaiting input” when AskUserQuestion is invoked
6. PostToolUse
When: After Claude executes any tool Status: Active - Algorithm state tracking
Current Hooks:
{
"PostToolUse": [
{
"hooks": [
{ "type": "command", "command": "$HOME/.claude/hooks/ContentScanner.hook.ts" }
]
},
{
"matcher": "AskUserQuestion",
"hooks": [
{ "type": "command", "command": "$HOME/.claude/hooks/QuestionAnswered.hook.ts" }
]
},
{
"matcher": "Write",
"hooks": [
{ "type": "command", "command": "$HOME/.claude/hooks/PRDSync.hook.ts" },
{ "type": "command", "command": "$HOME/.claude/hooks/TelosSummarySync.hook.ts" }
]
},
{
"matcher": "Edit",
"hooks": [
{ "type": "command", "command": "$HOME/.claude/hooks/PRDSync.hook.ts" },
{ "type": "command", "command": "$HOME/.claude/hooks/TelosSummarySync.hook.ts" }
]
},
{
"hooks": [
{ "type": "command", "command": "$HOME/.claude/hooks/ToolActivityTracker.hook.ts" }
]
}
]
}
What They Do:
ContentScanner.hook.ts - Prompt Injection Detection (Security v4.0)
- Fires after any tool use (global matcher)
- Runs InjectionInspector from the Inspector Pipeline to detect prompt injection attempts in tool output
- Part of the v4.0 security architecture; replaces the former PromptInjectionScanner
- Inspector source:
hooks/security/inspectors/
QuestionAnswered.hook.ts - Post-Question Processing
- Fires after AskUserQuestion completes (user has answered)
- Captures the question and answer for session context
- Used for analytics and learning from user preferences
PRDSync.hook.ts - PRD Frontmatter → work.json Sync
- Fires after Write/Edit to PRD files in
MEMORY/WORK/ - Syncs PRD frontmatter (status, title, effort) to
MEMORY/STATE/work.json - Keeps work registry in sync without manual updates
- Non-blocking, fire-and-forget
- Uses
hooks/lib/prd-utils.ts::appendPhase()(2026-04-16+) for phaseHistory withsource: "prd"— the other source being voice notifications. Both feed the same phaseHistory array with dedup via upgrade tosource: "merged". SeePAI/MEMORY/KNOWLEDGE/Ideas/dual-source-event-tracking-pattern.md.
TelosSummarySync.hook.ts - Principal TELOS Sync
- Fires after Write/Edit alongside PRDSync
- Regenerates PRINCIPAL_TELOS.md when TELOS source files are modified
ToolActivityTracker.hook.ts - Tool Activity Tracking + Ground-Truth Audit
- Fires after any tool use (global matcher)
- Tracks tool usage patterns for observability
- Captures a
ground_truthpayload for write-class tools (Edit/Write/MultiEdit/NotebookEdit): file path, bounded before/after diff, git HEAD + dirty flag - Captures a
ground_truthpayload for Bash: command, stdout/stderr preview, exit code - Feeds the Observer Team archetype (see PAIAGENTSYSTEM.md) which consumes the audit log rather than chat transcripts — watches what the model DID, not what it said
7. PostToolUseFailure
When: A tool execution fails Use Cases:
- Track tool failure patterns for debugging
- Identify flaky tools or recurring errors
- Observability data for system health
Current Hooks:
{
"PostToolUseFailure": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/ToolFailureTracker.hook.ts"
}
]
}
]
}
What It Does:
ToolFailureTracker.hook.ts- Appends structured failure events toMEMORY/OBSERVABILITY/tool-failures.jsonl- Captures: tool name, error message, truncated tool input, session ID, timestamp
- Lightweight (<20ms) — file append only, no inference calls
8. SubagentStart
When: A subagent is spawned (command-only event) Use Cases:
- Track agent spawning for cost attribution
- Record start time for duration calculation at stop
- Observe multi-agent team dynamics
Current Hooks:
{
"SubagentStart": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/SubagentTracker.hook.ts"
}
]
}
]
}
What It Does:
SubagentTracker.hook.ts- Appendssubagent_startevent toMEMORY/OBSERVABILITY/subagent-events.jsonl- Records start time in
MEMORY/OBSERVABILITY/subagent-starts.jsonkeyed by subagent_id for duration calculation at stop - Captures: subagent ID, type, model, prompt preview, session ID, timestamp
- Lightweight (<20ms) — file read/write only, no inference calls
9. ConfigChange
When: Configuration settings are modified (command-only event) Use Cases:
- Security audit trail for permission changes
- Track hook modifications
- Detect unauthorized config changes
Current Hooks:
{
"ConfigChange": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/ConfigAudit.hook.ts"
}
]
}
]
}
What It Does:
ConfigAudit.hook.ts- Appends config change events toMEMORY/OBSERVABILITY/config-changes.jsonl- Captures: config key, change summary (old → new), session ID, timestamp
- Flags sensitive keys (permissions, hooks, env, mcpServers) with extra logging
- Lightweight (<20ms) — file append only, no inference calls
10. PreCompact
When: Before Claude compacts context (long conversations)
Status: Active — PreCompact.hook.ts
Matcher: "*" (both auto and manual compaction)
What It Does:
PreCompact.hook.ts- Captures active work context before conversation compaction- Reads:
MEMORY/STATE/current-work*.json,MEMORY/WORK/*/PRD.md - Outputs structured handover note to stdout (preserved through compaction)
- Captures: active task, PRD summary, files modified, key decisions, working directory, session ID
- Lightweight (<100ms) — file reads only, no inference calls
Configuration:
{
"PreCompact": [
{
"matcher": "*",
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/PreCompact.hook.ts"
}
]
}
]
}
Relationship to Auto-Memory:
Claude Code’s built-in auto-memory system writes learnings to ~/.claude/projects/<project>/memory/MEMORY.md. The PreCompact hook complements this by preserving work-in-progress state that auto-memory doesn’t capture (active task context, PRD state, file lists). Auto-dream (server-controlled) periodically consolidates auto-memory files between sessions.
11. PostCompact
When: After Claude compacts context
Status: Active — RestoreContext.hook.ts
Current Hooks:
{
"PostCompact": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/RestoreContext.hook.ts"
}
]
}
]
}
What It Does:
RestoreContext.hook.ts- Restores critical context after compaction to prevent context loss
12. SubagentStop
When: A subagent completes (command-only event)
Status: Active — SubagentTracker.hook.ts
Current Hooks:
{
"SubagentStop": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/SubagentTracker.hook.ts"
}
]
}
]
}
What It Does:
SubagentTracker.hook.ts- Appendssubagent_stopevent toMEMORY/OBSERVABILITY/subagent-events.jsonl- Reads start time from
subagent-starts.json, computes duration in seconds - Emits stderr warning when duration exceeds 300 seconds (hung agent threshold)
- Handles orphaned stop events gracefully (no matching start record)
- Cleans up start record after computing duration
12a. TeammateIdle
When: An agent team teammate is about to go idle
Status: Active — TeammateIdle.hook.ts
Current Hooks:
{
"TeammateIdle": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/TeammateIdle.hook.ts"
}
]
}
]
}
What It Does:
TeammateIdle.hook.ts- Logs idle events toMEMORY/OBSERVABILITY/teammate-events.jsonl- Pure logging — does not block or redirect teammates
- Captures: teammate name, team name, session ID, timestamp
13. TaskCreated
When: A task is created via TaskCreate tool
Status: Active — TaskGovernance.hook.ts
Current Hooks:
{
"TaskCreated": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/TaskGovernance.hook.ts"
}
]
}
]
}
What It Does:
TaskGovernance.hook.ts- Validates and governs task creation for ISC quality standards
14. StopFailure
When: The main agent fails to complete a response
Status: Active — StopFailureHandler.hook.ts
Current Hooks:
{
"StopFailure": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/StopFailureHandler.hook.ts"
}
]
}
]
}
What It Does:
StopFailureHandler.hook.ts- Handles stop failures, captures error context for debugging
15. Elicitation
When: An elicitation event occurs
Status: Active — ElicitationHandler.hook.ts
Current Hooks:
{
"Elicitation": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/ElicitationHandler.hook.ts"
}
]
}
]
}
What It Does:
ElicitationHandler.hook.ts- Handles elicitation events for interactive user engagement
16. FileChanged
When: A file is changed on disk (external to Claude)
Status: Active — FileChanged.hook.ts
Current Hooks:
{
"FileChanged": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/FileChanged.hook.ts"
}
]
}
]
}
What It Does:
FileChanged.hook.ts- Reacts to external file changes, enabling watch-mode behaviors
17. InstructionsLoaded
When: Instructions (CLAUDE.md or project instructions) are loaded
Status: Active — InstructionsLoadedHandler.hook.ts
Current Hooks:
{
"InstructionsLoaded": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/InstructionsLoadedHandler.hook.ts"
}
]
}
]
}
What It Does:
InstructionsLoadedHandler.hook.ts- Processes loaded instructions for context enrichment or validation
Configuration
Location
File: ~/.claude/settings.json
Section: "hooks": { ... }
Environment Variables
Hooks have access to all environment variables from ~/.claude/settings.json "env" section:
{
"env": {
"PAI_DIR": "$HOME/.claude",
"CLAUDE_CODE_MAX_OUTPUT_TOKENS": "64000"
}
}
Key Variables:
PAI_DIR- PAI installation directory (typically~/.claude)- Hook scripts reference
$HOME/.claudein command paths
Identity Configuration (Central to Install Wizard)
settings.json is the single source of truth for all daidentity/configuration.
{
"daidentity": {
"name": "PAI",
"fullName": "Personal AI",
"displayName": "PAI",
"color": "#3B82F6",
"voices": {
"main": { "voiceId": "{YourElevenLabsVoiceId}", "stability": 0.85, "similarityBoost": 0.7 },
"algorithm": { "voiceId": "{AlgorithmVoiceId}" }
}
},
"principal": {
"name": "{YourName}",
"pronunciation": "{YourName}",
"timezone": "America/Your_City"
}
}
Using the Identity Module:
import { getIdentity, getPrincipal, getDAName, getPrincipalName, getVoiceId } from './lib/identity';
// Get full identity objects
const identity = getIdentity(); // { name, fullName, displayName, mainDAVoiceID, color, voice, personality }
const principal = getPrincipal(); // { name, pronunciation, timezone }
// Convenience functions
const DA_NAME = getDAName(); // "PAI"
const USER_NAME = getPrincipalName(); // "{YourName}"
const VOICE_ID = getVoiceId(); // from settings.json daidentity.voices.main.voiceId
Why settings.json?
- Programmatic access via
JSON.parse()- no regex parsing markdown - Central to the PAI install wizard
- Tool-friendly: easy to read/write from any language
Note:
settings.jsonis now a generated file —ConfigRenderer.tswrites it at session start fromPAI_CONFIG.yaml. Hooks should read it freely for runtime config, but understand that manual edits will be overwritten on next session start when ConfigRenderer detects a hash change. To make permanent config changes, editPAI_CONFIG.yamlinstead.
Hook Configuration Structure
{
"hooks": {
"HookEventName": [
{
"matcher": "pattern", // Optional: filter which tools/events trigger hook
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/my-hook.ts --arg value"
}
]
}
]
}
}
Fields:
HookEventName- One of: SessionStart, SessionEnd, UserPromptSubmit, Stop, StopFailure, PreToolUse, PostToolUse, PostToolUseFailure, SubagentStart, SubagentStop, ConfigChange, PreCompact, PostCompact, TaskCreated, TaskCompleted, TeammateIdle, Elicitation, ElicitationResult, FileChanged, CwdChanged, InstructionsLoaded, WorktreeCreate, WorktreeRemove, Notification, PermissionRequestmatcher- Pattern to match (use"*"for all tools, or specific tool names)type- Always"command"(executes external script)command- Path to executable hook script (TypeScript/Python/Bash)
Hook Input (stdin)
All hooks receive JSON data on stdin:
{
session_id: string; // Unique session identifier
transcript_path: string; // Path to JSONL transcript
hook_event_name: string; // Event that triggered hook
prompt?: string; // User prompt (UserPromptSubmit only)
tool_name?: string; // Tool name (PreToolUse/PostToolUse)
tool_input?: any; // Tool parameters (PreToolUse)
tool_output?: any; // Tool result (PostToolUse)
// ... event-specific fields
}
Common Patterns
1. Voice Notifications
Pattern: Extract completion message → Send to voice server
// handlers/VoiceNotification.ts pattern
import { getIdentity } from './lib/identity';
const identity = getIdentity();
const completionMessage = extractCompletionMessage(lastMessage);
const payload = {
title: identity.name,
message: completionMessage,
voice_enabled: true,
voice_id: identity.mainDAVoiceID // From settings.json
};
await fetch('http://localhost:31337/notify', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(payload)
});
Agent-Specific Voices:
Configure voice IDs via settings.json daidentity section or environment variables.
Each agent can have a unique ElevenLabs voice configured. See the Agents skill for voice registry.
2. History Capture (UOCS Pattern)
Pattern: Parse structured response → Save to appropriate history directory
File Naming Convention:
YYYY-MM-DD-HHMMSS_TYPE_description.md
Types:
WORK- General task completionsLEARNING- Problem-solving learningsSESSION- Session summariesRESEARCH- Research findings (from agents)FEATURE- Feature implementations (from agents)DECISION- Architectural decisions (from agents)
Example pattern (from WorkCompletionLearning.hook.ts):
import { getLearningCategory, isLearningCapture } from './lib/learning-utils';
import { getPSTTimestamp, getYearMonth } from './lib/time';
const structured = extractStructuredSections(lastMessage);
const isLearning = isLearningCapture(text, structured.summary, structured.analysis);
// If learning content detected, capture to LEARNING/
if (isLearning) {
const category = getLearningCategory(text); // 'SYSTEM' or 'ALGORITHM'
const targetDir = join(baseDir, 'MEMORY', 'LEARNING', category, getYearMonth());
const filename = generateFilename(description, 'LEARNING');
writeFileSync(join(targetDir, filename), content);
}
Structured Sections Parsed:
📋 SUMMARY:- Brief overview🔍 ANALYSIS:- Key findings⚡ ACTIONS:- Steps taken✅ RESULTS:- Outcomes📊 STATUS:- Current state➡️ NEXT:- Follow-up actions🎯 COMPLETED:- Voice notification line
3. Agent Type Detection
Pattern: Identify which agent is executing → Route appropriately
// Agent detection pattern
let agentName = getAgentForSession(sessionId);
// Detect from Task tool
if (hookData.tool_name === 'Task' && hookData.tool_input?.subagent_type) {
agentName = hookData.tool_input.subagent_type;
setAgentForSession(sessionId, agentName);
}
// Detect from CLAUDE_CODE_AGENT env variable
else if (process.env.CLAUDE_CODE_AGENT) {
agentName = process.env.CLAUDE_CODE_AGENT;
}
// Detect from path (subagents run in /agents/name/)
else if (hookData.cwd && hookData.cwd.includes('/agents/')) {
const agentMatch = hookData.cwd.match(/\/agents\/([^\/]+)/);
if (agentMatch) agentName = agentMatch[1];
}
Session Mapping: ~/.claude/PAI/MEMORY/STATE/agent-sessions.json
{
"session-id-abc123": "engineer",
"session-id-def456": "researcher"
}
4. Tab Title + Color State Architecture
Pattern: Visual state feedback through tab colors and title suffixes
State Flow:
| Event | Hook | Tab Title | Inactive Color | State |
|---|---|---|---|---|
| UserPromptSubmit | SessionAnalysis.hook.ts | ⚙️ Summary… | Orange #B35A00 | Working |
| Inference | SessionAnalysis.hook.ts | 🧠 Analyzing… | Orange #B35A00 | Inference |
| Stop (success) | handlers/TabState.ts | Summary | Green #022800 | Completed |
| Stop (question) | handlers/TabState.ts | Summary? | Teal #0D4F4F | Awaiting Input |
| Stop (error) | handlers/TabState.ts | Summary! | Orange #B35A00 | Error |
Active Tab: Always Dark Blue #002B80 (state colors only affect inactive tabs)
Why This Design:
- Instant visual feedback - See state at a glance without reading
- Color-coded priority - Teal tabs need attention, green tabs are done
- Suffix as state indicator - Works even in narrow tab bars
- Haiku only on user input - One AI call per prompt (not per tool)
State Detection (in Stop hook):
- Check transcript for
AskUserQuestiontool →awaitingInput - Check
📊 STATUS:for error patterns →error - Default →
completed
Text Colors:
- Active tab: White
#FFFFFF(always) - Inactive tab: Gray
#A0A0A0(always)
Active Tab Background: Dark Blue #002B80 (always - state colors only affect inactive tabs)
Tab Icons:
- 🧠 Brain - AI inference in progress (Haiku/Sonnet thinking)
- ⚙️ Gear - Processing/working state
Full Documentation: See ~/.claude/PAI/DOCUMENTATION/Pulse/TerminalTabs.md
5. Async Non-Blocking Execution
Pattern: Hook executes quickly → Launch background processes for slow operations
// SessionAnalysis.hook.ts pattern
// Set immediate tab title (fast)
execSync(`printf '\\033]0;${titleWithEmoji}\\007' >&2`);
// Launch background process for Haiku summary (slow)
Bun.spawn(['bun', `${paiDir}/hooks/SessionAnalysis.hook.ts`, prompt], {
stdout: 'ignore',
stderr: 'ignore',
stdin: 'ignore'
});
process.exit(0); // Exit immediately
Key Principle: Hooks must never block Claude Code. Always exit quickly, use background processes for slow work.
6. Graceful Failure
Pattern: Wrap everything in try/catch → Log errors → Exit successfully
async function main() {
try {
// Hook logic here
} catch (error) {
// Log but don't fail
console.error('Hook error:', error);
}
process.exit(0); // Always exit 0
}
Why: If hooks crash, Claude Code may freeze. Always exit cleanly.
Creating Custom Hooks
Step 1: Choose Hook Event
Decide which event should trigger your hook (SessionStart, Stop, PostToolUse, etc.)
Step 2: Create Hook Script
Template:
#!/usr/bin/env bun
interface HookInput {
session_id: string;
transcript_path: string;
hook_event_name: string;
// ... event-specific fields
}
async function main() {
try {
// Read stdin
const input = await Bun.stdin.text();
const data: HookInput = JSON.parse(input);
// Your hook logic here
console.log(`Hook triggered: ${data.hook_event_name}`);
// Example: Read transcript
const fs = require('fs');
const transcript = fs.readFileSync(data.transcript_path, 'utf-8');
// Do something with the data
} catch (error) {
// Log but don't fail
console.error('Hook error:', error);
}
process.exit(0); // Always exit 0
}
main();
Step 3: Make Executable
chmod +x ~/.claude/hooks/my-custom-hook.ts
Note: Not needed when using the
bunprefix in settings.json — all PAI hooks usebun $HOME/.claude/hooks/...which doesn’t require the execute bit.
Step 4: Add to settings.json
{
"hooks": {
"Stop": [
{
"hooks": [
{
"type": "command",
"command": "$HOME/.claude/hooks/my-custom-hook.ts"
}
]
}
]
}
}
Step 5: Test
# Test hook directly
echo '{"session_id":"test","transcript_path":"/tmp/test.jsonl","hook_event_name":"Stop"}' | bun ~/.claude/hooks/my-custom-hook.ts
Step 6: Restart Claude Code
Hooks are loaded at startup. Restart to apply changes.
Hook Development Best Practices
1. Fast Execution
- Hooks should complete in < 500ms
- Use background processes for slow work (Haiku API calls, file processing)
- Exit immediately after launching background work
2. Graceful Failure
- Always wrap in try/catch
- Log errors to stderr (available in hook debug logs)
- Always
process.exit(0)- never throw or exit(1)
3. Non-Blocking
- Never wait for external services (unless they respond quickly)
- Use
.catch(() => {})for async operations - Fail silently if optional services are offline
4. Stdin Reading
- Use timeout when reading stdin (Claude Code may not send data immediately)
- Handle empty/invalid input gracefully
const decoder = new TextDecoder();
const reader = Bun.stdin.stream().getReader();
const timeoutPromise = new Promise<void>((resolve) => {
setTimeout(() => resolve(), 500); // 500ms timeout
});
await Promise.race([readPromise, timeoutPromise]);
5. File I/O
- Check
existsSync()before reading files - Create directories with
{ recursive: true } - Use local-timezone timestamps for consistency (the utility resolves from your PAI config)
6. Environment Access
- All
settings.jsonenv vars available viaprocess.env - Use
$HOME/.claudein settings.json for portability - Access in code via
process.env.PAI_DIR
7. Logging
- Log useful debug info to stderr for troubleshooting
- Include relevant metadata (session_id, tool_name, etc.)
- Never log sensitive data (API keys, user content)
Troubleshooting
Hook Not Running
Check:
- Is hook script executable?
chmod +x ~/.claude/hooks/my-hook.ts(not needed when usingbunprefix — all PAI hooks usebunprefix) - Is path correct in settings.json? Use
bun $HOME/.claude/hooks/... - Is settings.json valid JSON?
jq . ~/.claude/settings.json - Did you restart Claude Code after editing settings.json?
Debug:
# Test hook directly
echo '{"session_id":"test","transcript_path":"/tmp/test.jsonl","hook_event_name":"Stop"}' | bun ~/.claude/hooks/my-hook.ts
# Check hook logs (stderr output)
tail -f ~/.claude/hooks/debug.log # If you add logging
Hook Hangs/Freezes Claude Code
Cause: Hook not exiting (infinite loop, waiting for input, blocking operation)
Fix:
- Add timeouts to all blocking operations
- Ensure
process.exit(0)is always reached - Use background processes for long operations
- Check stdin reading has timeout
Prevention:
// Always use timeout
setTimeout(() => {
console.error('Hook timeout - exiting');
process.exit(0);
}, 5000); // 5 second max
Voice Notifications Not Working
Check:
- Is voice server running?
curl http://localhost:31337/health - Is voice_id correct? See
settings.jsondaidentity.voicesfor mappings - Is message format correct?
{"message":"...", "voice_id":"...", "title":"..."} - Is ElevenLabs API key in
~/.claude/PAI/.env?
Debug:
# Test voice server directly
curl -X POST http://localhost:31337/notify \
-H "Content-Type: application/json" \
-d '{"message":"Test message","voice_id":"[YOUR_VOICE_ID]","title":"Test"}'
Common Issues:
- Wrong voice_id → Silent failure (invalid ID)
- Voice server offline → Hook continues (graceful failure)
- No
🎯 COMPLETED:line → No voice notification extracted
Work Not Capturing
Check:
- Does
~/.claude/PAI/MEMORY/directory exist? - Does current-work file exist? Check
~/.claude/ - Is hook actually running? Check
~/.claude/PAI/MEMORY/RAW/for events - File permissions?
ls -la ~/.claude/PAI/MEMORY/WORK/
Debug:
# Check current work
cat ~/.claude/PAI/MEMORY/STATE/current-work.json
# Check recent work directories
ls -lt ~/.claude/PAI/MEMORY/WORK/ | head -10
ls -lt ~/.claude/PAI/MEMORY/LEARNING/$(date +%Y-%m)/ | head -10
# Check raw events
tail ~/.claude/PAI/MEMORY/RAW/$(date +%Y-%m)/$(date +%Y-%m-%d)_all-events.jsonl
Common Issues:
- Missing current-work.json → Work not being tracked for this session
- Work not updating → capture handler not finding current work
- Learning detection too strict → Adjust
isLearningCapture()logic
Stop Event Not Firing (RESOLVED)
Original Issue: Stop events were not firing consistently in earlier Claude Code versions, causing voice notifications and work capture to fail silently.
Resolution: Fixed in Claude Code updates. The Stop hooks now fire reliably. The individual hook pattern (each .hook.ts delegating to handlers/) was implemented in part to work around this — and remains the production architecture.
Status: RESOLVED — Stop events now fire reliably. Individual Stop hooks handle all post-response work.
Agent Detection Failing
Check:
- Is
~/.claude/PAI/MEMORY/STATE/agent-sessions.jsonwritable? - Is
[AGENT:type]tag in🎯 COMPLETED:line? - Is agent running from correct directory? (
/agents/name/)
Debug:
# Check session mappings
cat ~/.claude/PAI/MEMORY/STATE/agent-sessions.json | jq .
# Check subagent-stop debug log
tail -f ~/.claude/hooks/subagent-stop-debug.log
Fix:
- Ensure agents include
[AGENT:type]in completion line - Verify Task tool passes
subagent_typeparameter - Check cwd includes
/agents/in path
Transcript Type Mismatch (Fixed 2026-01-11)
Symptom: Context reading functions return empty results even though transcript has data
Root Cause: Claude Code transcripts use type: "user" but hooks were checking for type: "human".
Affected Hooks:
SessionAnalysis.hook.ts- Couldn’t read user messages for contextSatisfactionCapture.hook.ts- Same issue
Fix Applied:
- Changed
entry.type === 'human'→entry.type === 'user' - Improved content extraction to skip
tool_resultblocks and only capture actual text
Verification:
# Check transcript type field
grep '"type":"user"' "$(ls -d ~/.claude/projects/*/ | head -1)"*.jsonl | head -1 | jq '.type'
# Should output: "user" (not "human")
Prevention: When parsing transcripts, always verify the actual JSON structure first.
Context Loading Issues (SessionStart)
Check:
- Does
~/.claude/CLAUDE.mdexist? - Is
LoadContext.hook.tsexecutable? - Is
PAI_DIRenv variable set correctly?
Debug:
# Test context loading directly
bun ~/.claude/hooks/LoadContext.hook.ts
# Should output <system-reminder> with SKILL.md content
Common Issues:
- Subagent sessions loading main context → Fixed (subagent detection in hook)
- File not found → Check
PAI_DIRenvironment variable - Permission denied →
chmod +x ~/.claude/hooks/LoadContext.hook.ts(not needed when usingbunprefix — all PAI hooks usebunprefix)
Advanced Topics
Multi-Hook Execution Order
Hooks in same event execute sequentially in order defined in settings.json:
{
"Stop": [
{
"hooks": [
{ "command": "$HOME/.claude/hooks/VoiceCompletion.hook.ts" } // Example: one of several Stop hooks
]
}
]
}
Note: If first hook hangs, second won’t run. Keep hooks fast!
Matcher Patterns
"matcher" field filters which events trigger hook:
{
"PostToolUse": [
{
"matcher": "Bash", // Only Bash tool executions
"hooks": [...]
},
{
"matcher": "*", // All tool executions
"hooks": [...]
}
]
}
Patterns:
"*"- All events"Bash"- Specific tool name""- Empty (all events, same as*)
Hook Data Payloads by Event Type
SessionStart:
{
session_id: string;
transcript_path: string;
hook_event_name: "SessionStart";
cwd: string;
}
UserPromptSubmit:
{
session_id: string;
transcript_path: string;
hook_event_name: "UserPromptSubmit";
prompt: string; // The user's prompt text
}
PreToolUse:
{
session_id: string;
transcript_path: string;
hook_event_name: "PreToolUse";
tool_name: string;
tool_input: any; // Tool parameters
}
PostToolUse:
{
session_id: string;
transcript_path: string;
hook_event_name: "PostToolUse";
tool_name: string;
tool_input: any;
tool_output: any; // Tool result
error?: string; // If tool failed
}
Stop:
{
session_id: string;
transcript_path: string;
hook_event_name: "Stop";
}
SessionEnd:
{
conversation_id: string; // Note: different field name
timestamp: string;
}
Related Documentation
- Voice System:
~/.claude/ - Agent System:
~/.claude/skills/Agents/SKILL.md - History/Memory:
~/.claude/PAI/DOCUMENTATION/Memory/MemorySystem.md
Quick Reference Card
HOOK LIFECYCLE:
1. Event occurs (SessionStart, Stop, etc.)
2. Claude Code writes hook data to stdin
3. Hook script executes
4. Hook reads stdin (with timeout)
5. Hook performs actions (voice, capture, etc.)
6. Hook exits 0 (always succeeds)
7. Claude Code continues
HOOKS BY EVENT (19 event types wired in settings.json; verified 2026-04-22):
SESSION START (3 hooks):
KittyEnvPersist.hook.ts Persist Kitty env vars + tab reset
LoadContext.hook.ts Dynamic context injection (relationship, learning, work)
KVSync.hook.ts Push work.json to Cloudflare KV
USER PROMPT SUBMIT (5 hooks):
PromptGuard.hook.ts Security: PromptInspector (injection/exfil/evasion)
RepeatDetection.hook.ts Detect repeated asks / repeat-request complaints
BrowserVerifyReminder.hook.ts Nudge Interceptor verification on web-class tasks
SessionAnalysis.hook.ts Unified: rating + tab title + session name (1 Haiku call)
SatisfactionCapture.hook.ts User satisfaction signal capture
PRE TOOL USE (4 distinct hooks across tool matchers + 2 Pulse HTTP routes):
SecurityPipeline.hook.ts Security validation [Bash, Edit, Write, Read, MultiEdit]
ContextReduction.hook.sh Context reduction via RTK [Bash]
ContainmentGuard.hook.ts Zone-write enforcement [Edit, Write, MultiEdit]
SetQuestionTab.hook.ts Tab state on question [AskUserQuestion]
Pulse HTTP: agent-guard Agent spawn guardrails (localhost:31337/hooks/agent-guard)
Pulse HTTP: skill-guard Skill invocation validation (localhost:31337/hooks/skill-guard)
POST TOOL USE (5 distinct hooks):
ContentScanner.hook.ts Security: InjectionInspector for prompt injection
QuestionAnswered.hook.ts Post-question tab reset [AskUserQuestion]
PRDSync.hook.ts PRD → work.json sync [Write, Edit]
TelosSummarySync.hook.ts TELOS edits → regenerate PRINCIPAL_TELOS.md [Write, Edit]
ToolActivityTracker.hook.ts Per-tool event log to OBSERVABILITY/
POST TOOL USE FAILURE (1 hook):
ToolFailureTracker.hook.ts Error logging to OBSERVABILITY/
STOP (4 hooks):
LastResponseCache.hook.ts Cache response for SessionAnalysis bridge
ResponseTabReset.hook.ts Tab title/color reset after response
VoiceCompletion.hook.ts Voice TTS (main sessions only)
DocIntegrity.hook.ts Cross-ref + arch summary regen
STOP FAILURE (1 hook):
StopFailureHandler.hook.ts Capture abnormal-stop diagnostics
SUBAGENT START (1 hook):
SubagentTracker.hook.ts Agent spawn logging to OBSERVABILITY/
SUBAGENT STOP (1 hook):
SubagentTracker.hook.ts Agent completion logging to OBSERVABILITY/
PERMISSION REQUEST (1 hook):
SmartApprover.hook.ts Auto-approve reversible local actions per policy
TASK CREATED (1 hook):
TaskGovernance.hook.ts Task-list ceiling + hygiene checks
TEAMMATE IDLE (1 hook):
TeammateIdle.hook.ts Idle-agent watchdog signal
FILE CHANGED (1 hook):
FileChanged.hook.ts Route external file-edit notifications
INSTRUCTIONS LOADED (1 hook):
InstructionsLoadedHandler.hook.ts Instructions-context bootstrap
ELICITATION (1 hook):
ElicitationHandler.hook.ts Claude-side elicitation response
CONFIG CHANGE (1 hook):
ConfigAudit.hook.ts Security audit trail to OBSERVABILITY/
PRE COMPACT (1 hook):
PreCompact.hook.ts Capture work context before compaction
POST COMPACT (1 hook):
RestoreContext.hook.ts Rehydrate active PRD/state after compaction
SESSION END (7 hooks):
WorkCompletionLearning.hook.ts Work/learning capture to MEMORY/
ULWorkSync.hook.ts UL GitHub-Issues task sync
SessionCleanup.hook.ts Mark WORK dir complete, clear state, reset tab
RelationshipMemory.hook.ts Relationship context to MEMORY/RELATIONSHIP/
UpdateCounts.hook.ts Refresh system counts (skills, hooks, signals)
IntegrityCheck.hook.ts System integrity checks
KVSync.hook.ts Push work.json to Cloudflare KV
KEY FILES:
~/.claude/settings.json Hook configuration (GENERATED by ConfigRenderer — read, don't hand-edit)
~/.claude/PAI_CONFIG.yaml Source of truth for config (ConfigRenderer reads this)
~/.claude/PAI/TOOLS/ConfigRenderer.ts Renders settings.json, CLAUDE.md, PAI_SYSTEM_PROMPT.md from PAI_CONFIG.yaml
~/.claude/hooks/ Hook scripts (39 files, .hook.ts + .hook.sh)
~/.claude/hooks/handlers/ Handler modules (6 files)
~/.claude/hooks/lib/ Shared libraries (16 files)
~/.claude/hooks/lib/learning-utils.ts Learning categorization
~/.claude/hooks/lib/time.ts PST timestamp utilities
~/.claude/PAI/MEMORY/WORK/ Work tracking
~/.claude/PAI/MEMORY/LEARNING/ Learning captures
~/.claude/PAI/MEMORY/STATE/ Runtime state
~/.claude/PAI/MEMORY/STATE/events.jsonl Unified event log (append-only)
~/.claude/PAI/MEMORY/OBSERVABILITY/ Tool failures, agent spawns, config changes
INFERENCE TOOL (for hooks needing AI):
Path: ~/.claude/PAI/TOOLS/Inference.ts
Import: import { inference } from '../../.claude/PAI/TOOLS/Inference'
Levels: fast (haiku/15s) | standard (sonnet/30s) | smart (opus/90s)
TAB STATE SYSTEM:
Inference: 🧠… Orange #B35A00 (AI thinking)
Working: ⚙️… Orange #B35A00 (processing)
Completed: Green #022800 (task done)
Awaiting: ? Teal #0D4F4F (needs input)
Error: ! Orange #B35A00 (problem detected)
Active Tab: Always Dark Blue #002B80 (state colors = inactive only)
VOICE SERVER:
URL: http://localhost:31337/notify
Payload: {"message":"...", "voice_id":"...", "title":"..."}
Configure voice IDs in individual agent files (`agents/*.md` persona frontmatter)
Shared Libraries
The hook system uses shared TypeScript libraries to eliminate code duplication:
hooks/lib/learning-utils.ts
Shared learning categorization logic.
import { getLearningCategory, isLearningCapture } from './lib/learning-utils';
// Categorize learning as SYSTEM (tooling/infra) or ALGORITHM (task execution)
const category = getLearningCategory(content, comment);
// Returns: 'SYSTEM' | 'ALGORITHM'
// Check if response contains learning indicators
const isLearning = isLearningCapture(text, summary, analysis);
// Returns: boolean (true if 2+ learning indicators found)
Used by: SessionAnalysis, WorkCompletionLearning
hooks/lib/time.ts
Shared PST timestamp utilities.
import {
getPSTTimestamp, // "2026-01-10 20:30:00 PST"
getPSTDate, // "2026-01-10"
getYearMonth, // "2026-01"
getISOTimestamp, // ISO8601 with offset
getFilenameTimestamp, // "2026-01-10-203000"
getPSTComponents // { year, month, day, hours, minutes, seconds }
} from './lib/time';
Used by: SessionAnalysis, WorkCompletionLearning, SessionSummary
hooks/lib/identity.ts
Identity and principal configuration from settings.json.
import { getIdentity, getPrincipal, getDAName, getPrincipalName, getVoiceId } from './lib/identity';
const identity = getIdentity(); // { name, fullName, displayName, mainDAVoiceID, color, voice, personality }
const principal = getPrincipal(); // { name, pronunciation, timezone }
Used by: handlers/VoiceNotification.ts, SessionAnalysis, handlers/TabState.ts
PAI/TOOLS/Inference.ts
Unified AI inference with three run levels.
import { inference } from '../../.claude/PAI/TOOLS/Inference';
// Fast (Haiku) - quick tasks, 15s timeout
const result = await inference({
systemPrompt: 'Summarize in 3 words',
userPrompt: text,
level: 'fast',
});
// Standard (Sonnet) - balanced reasoning, 30s timeout
const result = await inference({
systemPrompt: 'Analyze sentiment',
userPrompt: text,
level: 'standard',
expectJson: true,
});
// Smart (Opus) - deep reasoning, 90s timeout
const result = await inference({
systemPrompt: 'Strategic analysis',
userPrompt: text,
level: 'smart',
});
// Result shape
interface InferenceResult {
success: boolean;
output: string;
parsed?: unknown; // if expectJson: true
error?: string;
latencyMs: number;
level: 'fast' | 'standard' | 'smart';
}
Used by: SessionAnalysis (consolidated from RatingCapture + UpdateTabTitle + SessionAutoName)
Unified Event System
Alongside existing filesystem state writes (algorithm-state JSON, PRDs, session-names.json, etc.), hooks can emit structured events to a single append-only JSONL log. This provides a unified observability layer without replacing any existing state management.
Components
Usage in Hooks
Hooks call appendEvent() as a secondary write alongside their existing state writes. The emitter is synchronous, fire-and-forget, and silently swallows errors so it never blocks or crashes a hook.
// Inside an existing hook, AFTER the normal state write:
// appendEvent() writes to ~/.claude/PAI/MEMORY/STATE/events.jsonl
appendEvent({ type: 'work.created', source: 'PRDSync', slug: 'my-task' });
Event Structure
Every event has a common base shape plus type-specific fields:
timestamp(ISO 8601) — auto-injected byappendEvent()session_id— auto-injected fromCLAUDE_SESSION_IDenvsource— the hook or handler name that emitted the eventtype— dot-separated topic (e.g.,algorithm.phase,work.created,voice.sent,rating.captured)
Events use a dot-separated topic hierarchy for filtering. A custom.* escape hatch allows arbitrary extension without modifying the type system.
Event Type Categories
| Category | Types | Emitting Hooks |
|---|---|---|
work.* | created, completed | PRDSync, SessionCleanup |
session.* | named, completed | SessionCleanup |
rating.* | captured | SatisfactionCapture |
learning.* | captured | WorkCompletionLearning |
voice.* | sent | VoiceNotification |
prd.* | synced | PRDSync |
doc.* | integrity | DocIntegrity |
build.* | rebuild | RebuildSkill (DocRebuild handler) |
system.* | integrity | IntegrityCheck |
settings.* | counts_updated | UpdateCounts |
tab.* | updated | TabState, SessionAnalysis |
hook.* | error | Any hook (error reporting) |
custom.* | user-defined | Extensibility escape hatch |
Consuming Events
# Live tail (real-time monitoring)
tail -f ~/.claude/PAI/MEMORY/STATE/events.jsonl | jq
# Filter by type
tail -f ~/.claude/PAI/MEMORY/STATE/events.jsonl | jq 'select(.type | startswith("algorithm."))'
# Programmatic (Node/Bun fs.watch)
import { watch } from 'fs';
const eventsPath = `${process.env.HOME}/.claude/PAI/MEMORY/STATE/events.jsonl`;
watch(eventsPath, (eventType) => { /* read new lines */ });
Key Principles
- Additive only — events supplement existing state files, they never replace them
- Append-only —
events.jsonlis an immutable log, never rewritten or truncated by hooks - Graceful failure — write errors are swallowed; events are observability, not critical path
- One file — all event types go to a single
events.jsonlfor simple tailing and watching
Last Updated: 2026-04-20 Status: Production — 10 event types, 3 observability loggers (count auto-computed by UpdateCounts.ts) Maintainer: PAI System