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

    Interface ShellCommandExecution

    A single shell command to run through AbstractShellExecutionTool.runShellCommand.

    interface ShellCommandExecution {
        command: string;
        ctx?: unknown;
        cwd?: string;
        timeout?: number;
        truncation?: OutputTruncationOptions;
    }
    Index

    Properties

    command ctx? cwd? timeout? truncation?

    Properties

    command: string
    ctx?: unknown

    The invocation context, if any. Its tool call id makes the execution cancellable via AbstractShellExecutionTool.cancelExecution, and its cancellation token kills the underlying process when fired. Typed as unknown because tool handlers receive the context untyped; ToolInvocationContext narrows it.

    cwd?: string

    Absolute working directory. If omitted the command runs in the backend process' cwd.

    timeout?: number

    Timeout in milliseconds. Falls back to the backend default when omitted.

    truncation?: OutputTruncationOptions

    Overrides the default output truncation budget.

    Settings

    Member Visibility

    On This Page

    Properties