vigiles API reference
    Preparing search index...

    Interface HookOutput

    The JSON a hook may print on stdout (all fields optional).

    interface HookOutput {
        continue?: boolean;
        decision?: "approve" | "block";
        hookSpecificOutput?: {
            additionalContext?: string;
            hookEventName?: string;
            permissionDecision?: "allow" | "deny" | "ask";
            permissionDecisionReason?: string;
        };
        reason?: string;
        stopReason?: string;
        suppressOutput?: boolean;
        systemMessage?: string;
        readonly [k: string]: unknown;
    }

    Indexable

    • readonly [k: string]: unknown
    Index

    Properties

    continue? decision? hookSpecificOutput? reason? stopReason? suppressOutput? systemMessage?

    Properties

    continue?: boolean
    decision?: "approve" | "block"
    hookSpecificOutput?: {
        additionalContext?: string;
        hookEventName?: string;
        permissionDecision?: "allow" | "deny" | "ask";
        permissionDecisionReason?: string;
    }
    reason?: string
    stopReason?: string
    suppressOutput?: boolean
    systemMessage?: string

    Settings

    Member Visibility

    On This Page

    Properties