vigiles API reference
    Preparing search index...

    Interface HookProtocol

    HookProtocol — the hook-wire PORT (transport axis). How a harness signals that a hook blocked/denied a tool call: the block exit code, the decision values that mean "deny", and the env vars a synthesized event carries. The research (research/harness-landscape.md) found Claude Code and Codex hooks are nearly identical at the wire level (both: JSON on stdin, permissionDecision: "deny" / decision: "block" / exit 2) — so this descriptor is deliberately thin, and the fact that a second harness needs almost the same values IS the finding. What varies more (config format JSON-vs-TOML, the plugin-root token, the event names) lives in PluginLayout / HarnessDialect, not here.

    The Claude Code implementation is claudeCodeHookProtocol in src/adapters/claude-code/hook-protocol.ts.

    interface HookProtocol {
        blockExitCode: number;
        denyDecisionValues: readonly string[];
        eventEnvVars: readonly string[];
        matcherStyle?: "exact" | "regex";
        name: string;
    }
    Index

    Properties

    blockExitCode denyDecisionValues eventEnvVars matcherStyle? name

    Properties

    blockExitCode: number

    Exit code a hook process uses to block/deny a tool call (Claude Code: 2).

    denyDecisionValues: readonly string[]

    decision / permissionDecision values that mean "deny" the tool call.

    eventEnvVars: readonly string[]

    Env vars a synthesized hook event carries beyond the JSON on stdin (Claude Code passes the event on stdin only; Codex adds session_id/cwd/PLUGIN_ROOT/…).

    matcherStyle?: "exact" | "regex"

    How a tool matcher is written in the emitted hooks block — "exact" (Claude Code: the tool name / A|B alternation) or "regex" (Codex: an anchored regex ^(A|B)$). Optional (additive, non-breaking) — absent ⇒ "exact". Used by compileHookProgram when rendering the settings block.

    name: string

    Stable identifier, e.g. "claude-code".

    Settings

    Member Visibility

    On This Page

    Properties