Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.37 KB

File metadata and controls

51 lines (37 loc) · 2.37 KB

Documentation

@libar-dev/agent-harness-kit developer documentation.


Guides — Start Here

Guide What it covers
Getting Started Install, sub-path imports, first hook in 5 minutes
Writing Your First Hook executeHook, validateBashToolInput, permission() — end-to-end walkthrough
Configuring settings.json 5 handler types, matcher syntax, if/timeout/async fields
Cookbook 10 copy-pasteable recipes for common hook patterns
Troubleshooting Hook not firing, exit codes, debug logging, Zod errors

API Reference

Reference What it covers
Hook Events All 28 events — input fields, output shape, builder method
HookOutputBuilder Every method with signature and examples
Validators Tool-input validators, type guards, content validators, config validators
Types Full type catalogue — inputs, outputs, tools, config
Environment Variables Every CLAUDE_HOOK_* variable with type, default, and description

Architecture & Internal

Doc Audience
API Update Checklist Maintainer checklist for tracking Claude Code API changes
Export Sessions Script How the export-sessions utility works
Tail Sessions Script How the tail-session CLI works (modes, flags, marker offsets)

Upstream Reference (Mirrored)

Official Anthropic documentation mirrored for offline development use. Always check the official docs for the canonical, up-to-date version.

Doc Source
Hooks Reference Claude Code Hooks Reference
Hooks Guide Claude Code Hooks Guide
Settings Reference Claude Code Settings Reference
CLI Reference Claude Code CLI Reference
Headless Mode Claude Code Headless Mode