@edgible-team/sdk
    Preparing search index...

    Interface ExecuteOptions

    A single CLI invocation for CommandExecutor.execute.

    interface ExecuteOptions {
        args: string[];
        cwd?: string;
        env?: Record<string, string>;
        executable?: string;
        timeout?: number;
        useSudo?: boolean;
    }
    Index

    Properties

    args cwd? env? executable? timeout? useSudo?

    Properties

    args: string[]

    CLI arguments (e.g. ['agent', 'install', '--non-interactive']).

    cwd?: string

    Working directory (LocalExecutor only). Default: process.cwd().

    env?: Record<string, string>

    Extra env vars (merged over process.env locally; exported in the guest shell over SSH).

    executable?: string

    Script path run via node (LocalExecutor) — SshExecutor uses its guest CLI path instead.

    timeout?: number

    Timeout in ms. Default 30000.

    useSudo?: boolean

    Run via sudo -E (host) / sudo -E bash -c (guest) — root privileges. Default false.

    Settings

    Member Visibility

    On This Page

    Properties