Skip to main content

CommandHook

Struct CommandHook 

Source
#[non_exhaustive]
pub struct CommandHook { pub command: Option<String>, pub args: Option<Vec<String>>, pub timeout: Option<f64>, pub run_async: Option<bool>, pub async_rewake: Option<bool>, pub shell: Option<Shell>, pub condition: Option<String>, pub status_message: Option<String>, pub on_failure: Option<HookOnFailure>, pub extra: Extra, }
Expand description

A command hook.

Docs: settings reference.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§command: Option<String>

Shell command to execute. With args, the executable to spawn directly. See Exec form and shell form.

  • Values: string

Docs: command.

§args: Option<Vec<String>>

Argument list. When present, command is resolved as an executable and spawned directly with args as the argument vector, with no shell involved. See Exec form and shell form.

  • Values: array of strings

Docs: args.

§timeout: Option<f64>

Seconds before canceling. Claude Code doesn’t enforce it on a command hook you run with async: true. Defaults: 600 for command, http, and mcp_tool; 30 for prompt; 60 for agent.

  • Values: a number

Docs: timeout.

§run_async: Option<bool>

If true, runs in the background without blocking. See Run hooks in the background.

  • Values: Boolean

Docs: async.

§async_rewake: Option<bool>

If true, runs in the background and wakes Claude on exit code 2. The hook’s stderr, or stdout if stderr is empty, is shown to Claude as a system reminder so it can react to a long-running background failure.

  • Values: Boolean

Docs: asyncRewake.

§shell: Option<Shell>

Shell to use for this hook. Accepts "bash" or "powershell". Defaults to "bash", or to "powershell" on Windows when Git Bash isn’t installed.

  • Values: "bash", "powershell"

Docs: shell.

§condition: Option<String>

Permission rule syntax to filter when this hook runs, such as "Bash(git *)" or "Edit(*.ts)". The hook command only runs if the tool call matches the pattern. See the Bash matching table for how Bash patterns evaluate against subcommands, $(), and backticks.

  • Values: string

Docs: if.

§status_message: Option<String>

Custom spinner message displayed while the hook runs.

  • Values: string

Docs: statusMessage.

§on_failure: Option<HookOnFailure>

Whether the action that triggered the hook goes ahead when the hook fails: "continue" or "block". See Block the action when a hook fails for "block" and for leaving the field unset. Requires Claude Code v2.1.295 or later.

  • Values: "continue" or "block". Requires Claude Code v2.1.295 or later
  • Default: unset: the action goes ahead on most events

Docs: onFailure.

§extra: Extra

Keys Claude Code accepts here that this crate doesn’t model (newer or undocumented ones), kept as written so the document round-trips.

Implementations§

Source§

impl CommandHook

Source

pub fn new(command: impl Into<String>) -> Self

A command hook running command in a shell.

Source

pub fn with_timeout(self, seconds: f64) -> Self

Sets timeout, in seconds.

Trait Implementations§

Source§

impl Clone for CommandHook

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandHook

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CommandHook

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CommandHook

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for CommandHook

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for CommandHook

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CommandHook

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.