Beignet API reference
    Preparing search index...

    Type Alias ExplainAppResult

    Version 1 deterministic explanation of one app-map target.

    type ExplainAppResult = {
        app: AppMapResult["app"];
        conventions: string[];
        evidence: ExplainEvidence[];
        findings: ExplainFinding[];
        query: { kind: ExplainTargetKind; target: string };
        relationships: ExplainRelationship[];
        schemaVersion: 1;
        scope: {
            findings: number;
            nodes: number;
            relationships: number;
            returnedRelationships: number;
            truncated: boolean;
        };
        suggestedActions: ExplainSuggestedAction[];
        suggestedFiles: ExplainSuggestedFile[];
        summary: string;
        target: ExplainTarget;
        targetDir: string;
    }
    Index
    conventions: string[]
    evidence: ExplainEvidence[]
    findings: ExplainFinding[]
    query: { kind: ExplainTargetKind; target: string }
    relationships: ExplainRelationship[]
    schemaVersion: 1
    scope: {
        findings: number;
        nodes: number;
        relationships: number;
        returnedRelationships: number;
        truncated: boolean;
    }
    suggestedActions: ExplainSuggestedAction[]
    suggestedFiles: ExplainSuggestedFile[]
    summary: string
    targetDir: string