ShellCommandFailedError

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/dist/core/shell/ShellCommandFailedError.d.ts:28

A run_* command that did NOT exit cleanly (non-zero exit code, or was killed for exceeding the timeout). Carries the FULL model-facing body text (output) so a softening middleware can hand the model the exact same observation it saw before — the only change is the tool result’s status flips to 'error', which drives the ✗ (isError) glyph.

executeCommand previously resolve()d on a non-zero exit, so the LangChain ToolMessage stayed status: 'success' and every failure rendered a ✓. Throwing this typed error instead lets each agent’s softening middleware convert it into an error ToolMessage. A clean exit (code === 0) still resolve()s; a spawn-level child.on('error') still rejects with a plain Error.

Extends

Error

Constructors

Constructor

new ShellCommandFailedError(params): ShellCommandFailedError

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/dist/core/shell/ShellCommandFailedError.d.ts:37

Parameters

params

command

string

exitCode

number | null

output

string

toolName

string

Returns

ShellCommandFailedError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: websites/gauntsloth-docs-site/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

command

readonly command: string

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/dist/core/shell/ShellCommandFailedError.d.ts:34

The exact command string that was executed.

exitCode

readonly exitCode: number | null

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/dist/core/shell/ShellCommandFailedError.d.ts:32

The process exit code; null when the command was killed (timeout) and never exited cleanly.

message

message: string

Defined in: websites/gauntsloth-docs-site/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

name

name: string

Defined in: websites/gauntsloth-docs-site/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

output

readonly output: string

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/dist/core/shell/ShellCommandFailedError.d.ts:30

The full model-facing body (command echo + <COMMAND_OUTPUT> + the failure/timeout tail).

stack?

optional stack?: string

Defined in: websites/gauntsloth-docs-site/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

toolName

readonly toolName: string

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/dist/core/shell/ShellCommandFailedError.d.ts:36

The run_* tool name that invoked the command (e.g. run_tests, run_shell_command).

stackTraceLimit

static stackTraceLimit: number

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace