Lifecycle Hooks
Hooks let you observe and gate agent activity as it happens. You register a named
callback against a lifecycle event, the runtime invokes it at that point, and the
callback returns a decision such as { action: "continue" }. Use hooks for
auditing, redaction, logging, or enforcing policy without changing the agent's
prompt.
The lifecycle is symmetric: registerHook adds a callback by name, hookCount
tells you how many are active, and unregisterHook removes one by its name.
Notes:
- A hook callback returns a decision. Return
{ action: "continue" }(Node) /{"action": "continue"}(Python) /&code.HookResponse{Action: "continue"}(Go) to let the agent proceed. - The matcher (
{ pathPattern: '**/.env*' }) scopes the hook to events whose path matches the pattern, and{ priority: 100 }orders hooks on the same event (lower values run first). - Node hook callbacks must not throw — an uncaught throw can abort the process. Keep the handler body total and always return a decision.
hookCount/hook_count/HookCountreflects the number of currently registered hooks, which is handy in tests to assert that registration and cleanup happened.unregisterHook/unregister_hook/UnregisterHooktakes the name you registered with. Always tear down hooks you no longer need so they do not leak across runs.- Validate the event path you depend on before using a hook as a production gate.