clyops Node API
    Preparing search index...

    Interface ToolRunOptions

    Process execution options combined with JSON-to-argv mapping and path restrictions.

    interface ToolRunOptions {
        cwd?: string;
        env?: ProcessEnv;
        maxOutput?: number;
        onStderr?: (chunk: string) => void;
        onStdout?: (chunk: string) => void;
        positionalsOrder?: "first" | "last";
        secretsInEnv?: boolean;
        signal?: AbortSignal;
        stdin?: string | Readable | Buffer<ArrayBufferLike>;
        stdout?: "text" | "buffer" | "stream";
        timeoutMs?: number;
        within?: string[];
    }

    Hierarchy (View Summary)

    Index
    cwd? env? maxOutput? onStderr? onStdout? positionalsOrder? secretsInEnv? signal? stdin? stdout? timeoutMs? within?
    cwd?: string

    Working directory used to resolve command-line paths and execute tools.

    env?: ProcessEnv

    Environment supplied to the process or read for option defaults.

    maxOutput?: number

    Keep at most this many bytes of stdout and of stderr (0 or unset: all); the rest is dropped and truncated set.

    onStderr?: (chunk: string) => void

    Called for each decoded stderr chunk.

    onStdout?: (chunk: string) => void

    Called for each decoded stdout chunk.

    positionalsOrder?: "first" | "last"

    Positionals before or after options (default: first).

    secretsInEnv?: boolean

    Pass secret inputs in the environment instead of on the command line (default: true).

    signal?: AbortSignal

    Abort the process tree (SIGTERM, then SIGKILL after a short grace period).

    stdin?: string | Readable | Buffer<ArrayBufferLike>

    Fed to the tool's stdin, which is closed otherwise.

    stdout?: "text" | "buffer" | "stream"

    How stdout is kept: 'text' (default) as a string, 'buffer' as bytes in stdoutBuffer for binary output, or 'stream' not at all: read it from start()'s stdout as the tool writes it.

    timeoutMs?: number

    Kill the tool and its process tree after this long; 0 or unset waits forever.

    within?: string[]

    Path-valued inputs must resolve inside these directories (see toArgv's within).

    Settings
    Member Visibility

    On This Page
    Properties