vigiles API reference
    Preparing search index...

    Interface CompileHookOptions

    Per-harness emit inputs (all optional, default to Claude Code) — the ports the CLI threads in from the resolved adapter. Keeps the core harness-agnostic: core depends only on these interfaces, never an adapter (core ⊄ adapter).

    interface CompileHookOptions {
        dialect?: HarnessDialect;
        gateCommand?: string;
        hookProtocol?: HookProtocol;
        registeredProviders?: readonly string[];
        settingsFormat?: "json" | "toml";
    }
    Index

    Properties

    dialect? gateCommand? hookProtocol? registeredProviders? settingsFormat?

    Properties

    dialect?: HarnessDialect

    Validate hook.on against this harness's hook-event catalog (a typo won't compile).

    gateCommand?: string

    The command the emitted block routes the event to.

    hookProtocol?: HookProtocol

    Matcher style (exact vs anchored regex). Defaults to Claude Code's "exact".

    registeredProviders?: readonly string[]

    Names of registered providers (.vigiles/providers/) a provider() ref may resolve to.

    settingsFormat?: "json" | "toml"

    Settings encoding — "json" (Claude Code) or "toml" (Codex). From PluginLayout.settingsFormat.

    Settings

    Member Visibility

    On This Page

    Properties