Struct LifecycleHooksConfig 

pub struct LifecycleHooksConfig {

    pub quiet_success_output: bool,
    pub session_start: Vec<HookGroupConfig>,
    pub session_end: Vec<HookGroupConfig>,
    pub subagent_start: Vec<HookGroupConfig>,
    pub subagent_stop: Vec<HookGroupConfig>,
    pub user_prompt_submit: Vec<HookGroupConfig>,
    pub pre_tool_use: Vec<HookGroupConfig>,
    pub post_tool_use: Vec<HookGroupConfig>,
    pub permission_request: Vec<HookGroupConfig>,
    pub pre_compact: Vec<HookGroupConfig>,
    pub stop: Vec<HookGroupConfig>,
    pub task_completion: Vec<HookGroupConfig>,
    pub task_completed: Vec<HookGroupConfig>,
    pub notification: Vec<HookGroupConfig>,
}

Configuration for hooks triggered during distinct agent lifecycle events. Each event supports a list of groups with optional matchers.

Fields

quiet_success_output: bool

Suppress plain stdout from successful hooks unless they emit structured fields

session_start: Vec<HookGroupConfig>

Commands to run immediately when an agent session begins

session_end: Vec<HookGroupConfig>

Commands to run when an agent session ends

subagent_start: Vec<HookGroupConfig>

Commands to run when a delegated subagent starts

subagent_stop: Vec<HookGroupConfig>

Commands to run when a delegated subagent stops

user_prompt_submit: Vec<HookGroupConfig>

Commands to run when the user submits a prompt (pre-processing)

pre_tool_use: Vec<HookGroupConfig>

Commands to run immediately before a tool is executed

post_tool_use: Vec<HookGroupConfig>

Commands to run immediately after a tool returns its output

permission_request: Vec<HookGroupConfig>

Commands to run when VT Code is about to request interactive permission approval

pre_compact: Vec<HookGroupConfig>

Commands to run immediately before VT Code compacts conversation history

stop: Vec<HookGroupConfig>

Commands to run after VT Code produces a final answer but before the turn completes

task_completion: Vec<HookGroupConfig>

Deprecated alias for stop

task_completed: Vec<HookGroupConfig>

Deprecated alias for stop

notification: Vec<HookGroupConfig>

Commands to run when VT Code emits a runtime notification event

Implementations

impl LifecycleHooksConfig

pub fn is_empty(&self) -> bool

pub fn normalized(&self) -> Self

impl LifecycleHooksConfig

pub fn validate(&self) -> Result<()>

Trait Implementations

impl Clone for LifecycleHooksConfig

fn clone(&self) -> LifecycleHooksConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LifecycleHooksConfig

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

Formats the value using the given formatter.

impl Default for LifecycleHooksConfig

fn default() -> LifecycleHooksConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LifecycleHooksConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for LifecycleHooksConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for LifecycleHooksConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.