Theia API Documentation v1.77.0
    Preparing search index...

    Outcome of attempting to migrate one workspace root. Roots without a legacy file produce no report.

    interface AgentsMdMigrationReport {
        alreadyPresent: boolean;
        backedUp: boolean;
        containsPromptSyntax: boolean;
        error?: string;
        migrated: boolean;
        root: URI;
    }
    Index
    alreadyPresent: boolean

    Whether an AGENTS.md was already present, so the legacy file was only backed up.

    backedUp: boolean

    Whether the legacy file was renamed to .bak.

    containsPromptSyntax: boolean

    Whether the migrated content still contains {{...}} or ~{...} references. AGENTS.md is read as a plain file, never resolved as a prompt fragment, so those references are now inert.

    error?: string

    Set when the root could not be migrated.

    migrated: boolean

    Whether AGENTS.md was written from the legacy file.

    root: URI

    The workspace root this report belongs to.