vigiles API reference
    Preparing search index...

    Interface FileToolEventOptions

    Options for fileToolEvents.

    interface FileToolEventOptions {
        event?: string;
        extra?: Readonly<Record<string, unknown>>;
        input?: Readonly<Record<string, unknown>>;
        root?: string;
        tool?: string;
    }
    Index

    Properties

    event? extra? input? root? tool?

    Properties

    event?: string

    The hook event. Default "PostToolUse" (the react tier's event).

    extra?: Readonly<Record<string, unknown>>

    Extra top-level event fields.

    input?: Readonly<Record<string, unknown>>

    Extra tool_input fields (old_string, content, …).

    root?: string

    The project root the absolute spelling is built from, and the value put in each event's cwd. Defaults to $CLAUDE_PROJECT_DIR, then process.cwd() — a TEST may read its own cwd, the RUNTIME may not (see projectRootOf).

    tool?: string

    The tool. Default "Edit".

    Settings

    Member Visibility

    On This Page

    Properties