Cell API
    Preparing search index...

    Interface CodingAgentOptions

    cell.ai.codingAgent. Names follow the options of pi's createAgentSession().

    interface CodingAgentOptions {
        agentDir?: string;
        allowModelNetwork?: boolean;
        apiKeys?: Record<string, string | undefined>;
        appendSystemPrompt?: string;
        codemode?: "off" | "on" | "only";
        cwd?: string;
        discoverResources?: boolean;
        excludeTools?: string[];
        mcp?: CodingAgentMcpOptions;
        model?: string;
        persistSessions?: boolean;
        systemPrompt?: string;
        thinkingLevel?: ThinkingLevel;
        tools?: string[];
        toolSearch?: boolean;
    }
    Index
    agentDir? allowModelNetwork? apiKeys? appendSystemPrompt? codemode? cwd? discoverResources? excludeTools? mcp? model? persistSessions? systemPrompt? thinkingLevel? tools? toolSearch?
    agentDir?: string

    pi's global directory (auth.json, models.json, settings.json, extensions, skills). Default: ~/.pi/agent.

    allowModelNetwork?: boolean

    Let the model runtime refresh model catalogs over the network when it is created. Default: false.

    apiKeys?: Record<string, string | undefined>

    API keys by provider id, e.g. anthropic: "${ env.MY_KEY }". Empty values are ignored.

    appendSystemPrompt?: string

    Appended to the system prompt.

    codemode?: "off" | "on" | "only"

    pi's codemode tool: the model writes JavaScript that calls tools in a sandbox. only hides the tools codemode can call. Default: off.

    cwd?: string

    Working directory of sessions: tools act here and project resources are found here. Default: the process directory.

    discoverResources?: boolean

    Load extensions, skills, prompt templates and AGENTS.md from cwd and agentDir as the pi CLI does. Default: true.

    excludeTools?: string[]
    mcp?: CodingAgentMcpOptions

    pi's MCP client: the servers of mcp.json (agentDir, and the project once trusted) plus servers.

    model?: string

    <provider>/<model id>. Default: pi's settings, then the first model with credentials.

    persistSessions?: boolean

    Write sessions as JSONL files where the pi CLI keeps them (pi --resume lists them). Default: false.

    systemPrompt?: string

    Replaces pi's system prompt.

    thinkingLevel?: ThinkingLevel
    tools?: string[]

    Allowlist of tool names; * matches any characters. Default: read, bash, edit, write and extension tools.

    toolSearch?: boolean

    pi's tool_search tool, which finds tools that are not declared to the model. Default: false.

    Settings
    Member Visibility

    On This Page
    Properties