AgentOS Extensions API - v1.0.3
    Preparing search index...

    Interface ShellConfig

    Shell configuration options

    interface ShellConfig {
        agentWorkspace?: {
            agentId: string;
            baseDir?: string;
            createIfMissing?: boolean;
            enabled?: boolean;
            subdirs?: string[];
        };
        allowedCommands?: string[];
        blockedCommands?: string[];
        dangerouslySkipSecurityChecks?: boolean;
        defaultShell?: "bash"
        | "powershell"
        | "cmd"
        | "zsh"
        | "sh"
        | "auto";
        env?: Record<string, string>;
        filesystem?: {
            allowRead?: boolean;
            allowWrite?: boolean;
            readRoots?: string[];
            writeRoots?: string[];
        };
        timeout?: number;
        workingDirectory?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    agentWorkspace? allowedCommands? blockedCommands? dangerouslySkipSecurityChecks? defaultShell? env? filesystem? timeout? workingDirectory?

    Properties

    agentWorkspace?: {
        agentId: string;
        baseDir?: string;
        createIfMissing?: boolean;
        enabled?: boolean;
        subdirs?: string[];
    }

    Optional per-agent workspace helper. When provided, the extension can auto-create an agent-specific directory and (optionally) default the workingDirectory/readRoots/writeRoots to that directory.

    Type Declaration

    • agentId: string

      Folder name for this agent.

    • OptionalbaseDir?: string

      Base directory under which per-agent folders are created.

    • OptionalcreateIfMissing?: boolean

      Create the workspace directory if missing. Default: true.

    • Optionalenabled?: boolean

      Enable workspace behavior when provided. Default: true.

    • Optionalsubdirs?: string[]

      Subdirectories to create inside the workspace. Default: ['assets','exports','tmp']

    allowedCommands?: string[]

    Whitelist of allowed commands (empty = all allowed)

    blockedCommands?: string[]

    Blacklist of blocked commands

    dangerouslySkipSecurityChecks?: boolean

    Disable all command safety checks (dangerous patterns, allow/deny lists). Use only in trusted environments.

    defaultShell?: "bash" | "powershell" | "cmd" | "zsh" | "sh" | "auto"

    Default shell to use

    env?: Record<string, string>

    Environment variables to inject

    filesystem?: {
        allowRead?: boolean;
        allowWrite?: boolean;
        readRoots?: string[];
        writeRoots?: string[];
    }

    Optional filesystem access policy for the file_* tools.

    When omitted, file tools can access any path (legacy behavior). When set, read/write/list operations are restricted to the configured roots.

    Type Declaration

    • OptionalallowRead?: boolean

      Allow file reads and directory listings. Default: false.

    • OptionalallowWrite?: boolean

      Allow file writes. Default: false.

    • OptionalreadRoots?: string[]

      Allowed root directories for reads/listing.

    • OptionalwriteRoots?: string[]

      Allowed root directories for writes.

    timeout?: number

    Default timeout for commands (ms)

    workingDirectory?: string

    Default working directory

    Settings

    Member Visibility

    On This Page

    Properties