FlowGuard API - v1.2.0-rc.2
    Preparing search index...

    Interface FlowGuardProfile

    A FlowGuard profile — tech-stack-aware validation configuration.

    Profiles determine:

    • Which checks are active for a session (activeChecks)
    • Whether the profile matches a given repository (detect)
    • Additional LLM instructions for the tech stack (instructions)

    P10a: No heuristic executors. The agent must run real tooling.

    interface FlowGuardProfile {
        id: string;
        name: string;
        activeChecks: readonly string[];
        detect?: (input: ProfileDetectionInput) => number;
        instructions?: string | PhaseInstructions;
    }
    Index

    Properties

    id name activeChecks detect? instructions?

    Properties

    id: string

    Unique profile identifier (e.g., "baseline", "backend-java", "frontend-react").

    name: string

    Human-readable profile name.

    activeChecks: readonly string[]

    Check IDs that are active in this profile. P10a: no heuristic executors — agent must run real validation.

    detect?: (input: ProfileDetectionInput) => number

    Auto-detection function. Returns a confidence score (0-1) for how well this profile matches the repo. 0 = no match, 1 = perfect match. If omitted, the profile can only be selected explicitly.

    instructions?: string | PhaseInstructions

    Additional LLM instructions injected when this profile is active.

    Accepts either:

    • A plain string (backward compatible — same instructions for all phases).
    • A PhaseInstructions object with base + optional byPhase overrides.

    Use resolveProfileInstructions(profile.instructions, phase) to resolve the effective instructions for a given phase.

    Settings

    Member Visibility

    On This Page

    Properties