Struct HookConfig 

pub struct HookConfig {
    pub event: HookEvent,
    pub tool_match: String,
    pub command: String,
    pub block_on_failure: bool,
    pub feedback: bool,
    pub timeout_secs: u64,
}

A single shell hook attached to tool execution.

[[hooks]]
event = "pre_tool"
match = "bash"           # tool name; `*` or `prefix*` / `*suffix`
command = "echo check"
block_on_failure = true  # pre_tool / user_prompt_submit: non-zero exit refuses
feedback = false         # stdout of a successful hook goes to the model
timeout_secs = 30

Environment for the command: WHYCODES_HOOK_EVENT, WHYCODES_TOOL_NAME, WHYCODES_TOOL_INPUT (JSON), WHYCODES_TOOL_ID, WHYCODES_SESSION_ID, WHYCODES_WORKING_DIR. Post-tool also sets WHYCODES_TOOL_IS_ERROR and WHYCODES_TOOL_OUTPUT (truncated). Lifecycle events add their own variables (WHYCODES_PROMPT, WHYCODES_RESPONSE, WHYCODES_SUBAGENT_*).

Fields

event: HookEvent

pre_tool, pre_tool_transform, post_tool, session_start, user_prompt_submit, stop, pre_compact, or subagent_stop.

tool_match: String

Tool name pattern. Default * (all tools).

command: String

Shell command (run via sh -c / cmd /C).

block_on_failure: bool

When true on pre_tool / user_prompt_submit, a non-zero exit refuses the tool call / the turn.

feedback: bool

When true, a successful hook’s stdout is shown to the model: appended to the tool result (post_tool) or to the user turn (session_start, user_prompt_submit). Ignored for other events.

timeout_secs: u64

Kill the hook after this many seconds. Default 30.

Trait Implementations

impl Clone for HookConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HookConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HookConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HookConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HookConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.