pai
    Preparing search index...

    Type Alias SetupResult

    What setupAgents did.

    type SetupResult = {
        agents: {
            agent: SetupAgent;
            mcp: string | null;
            mcp_added: boolean;
            provider?: ProviderResult;
            skill: string | null;
        }[];
        applied?: boolean;
        dry_run?: boolean;
        files: {
            action: SetupFile["action"];
            agent: SetupAgent
            | "shell";
            backup?: string;
            diff?: string;
            file: string;
        }[];
        notes?: string[];
        skipped?: SetupPlan["skipped"];
    }
    Index
    agents applied? dry_run? files notes? skipped?
    agents: {
        agent: SetupAgent;
        mcp: string | null;
        mcp_added: boolean;
        provider?: ProviderResult;
        skill: string | null;
    }[]

    One entry per agent set up.

    Type Declaration

    • agent: SetupAgent

      The agent.

    • mcp: string | null

      How to add the MCP server to this agent by hand. null for an agent with no MCP, such as pi.

    • mcp_added: boolean

      True when --mcp added the MCP server.

    • Optionalprovider?: ProviderResult

      What --provider (or plain pai setup) changed in the agent's settings, for an agent that supports it.

    • skill: string | null

      The path of the skill. null for an agent without skills.

    applied?: boolean

    False when the user said no at the prompt: nothing was written.

    dry_run?: boolean

    True with --dry-run: nothing was written.

    files: {
        action: SetupFile["action"];
        agent: SetupAgent | "shell";
        backup?: string;
        diff?: string;
        file: string;
    }[]

    Each file written, or with --dry-run each file that would be.

    Type Declaration

    • action: SetupFile["action"]

      create, update or remove.

    • agent: SetupAgent | "shell"

      The agent it is for, or shell.

    • Optionalbackup?: string

      The copy of the file from before pai changed it.

    • Optionaldiff?: string

      The change as a line diff, with keys masked. Left out for the skill.

    • file: string

      The file.

    notes?: string[]

    Things to know, such as setting up without a key.

    skipped?: SetupPlan["skipped"]

    What was left alone, and why, such as a config file that does not parse.

    Settings
    Member Visibility

    On This Page
    Properties