> ## Documentation Index
> Fetch the complete documentation index at: https://easyaf.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# BashToolResponse

> Represents the response payload returned by the Claude Code Bash tool after executing             a shell command.

## Definition

**Assembly:** CloudNimble.ClaudeEssentials.dll

**Namespace:** CloudNimble.ClaudeEssentials.Hooks.Tools.Responses

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
CloudNimble.ClaudeEssentials.Hooks.Tools.Responses.BashToolResponse
```

## Summary

Represents the response payload returned by the Claude Code Bash tool after executing
a shell command.

## Remarks

The Bash tool executes shell commands in a persistent shell session. This response is
received in the [BashPostToolUsePayload](/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/BashPostToolUsePayload)
when the `tool_name` is "Bash".

Commands have a default timeout of 120 seconds (2 minutes), which can be extended
up to 600 seconds (10 minutes) using the [BashToolInput.Timeout](/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Inputs/BashToolInput#timeout) parameter.
If a command exceeds its timeout, it will be interrupted and [BashToolResponse.Interrupted](/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Responses/BashToolResponse#interrupted)
will be `true`.

Output exceeding 30,000 characters is automatically truncated by Claude Code.

Example JSON payload:

```csharp theme={"dark"}
{
"stdout": "Hello, World!\r\n",
"stderr": "",
"interrupted": false,
"isImage": false
}
```

## Constructors

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor

#### Syntax

```csharp theme={"dark"}
public BashToolResponse()
```

### <Icon icon="hammer" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> .ctor <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Interrupted

Gets or sets a value indicating whether the command was interrupted before completion.

#### Syntax

```csharp theme={"dark"}
public bool Interrupted { get; set; }
```

#### Property Value

Type: `bool`

#### Remarks

When `true`, the command did not complete normally. This typically occurs when:

* The command exceeded its timeout (default 120 seconds, max 600 seconds)
* The user manually cancelled the operation
* The command was killed by the system

  When a command is interrupted, [BashToolResponse.Stdout](/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Responses/BashToolResponse#stdout) and [BashToolResponse.Stderr](/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Responses/BashToolResponse#stderr) will
  contain whatever output was captured before the interruption occurred.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> IsImage

Gets or sets a value indicating whether the output contains image data.

#### Syntax

```csharp theme={"dark"}
public bool IsImage { get; set; }
```

#### Property Value

Type: `bool`

#### Remarks

When `true`, the command produced image output that Claude can interpret
visually. This is used for commands that generate images or graphical output.

Claude is a multimodal LLM and can process image data directly. When this is
`true`, the [BashToolResponse.Stdout](/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Responses/BashToolResponse#stdout) may contain base64-encoded image data
or be empty while the image is presented to Claude separately.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Stderr

Gets or sets the standard error (stderr) output from the executed command.

#### Syntax

```csharp theme={"dark"}
public string Stderr { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

This contains all text written to stderr by the command. Many commands write
warnings, progress information, or diagnostic messages to stderr even when
successful.

An empty [BashToolResponse.Stderr](/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Responses/BashToolResponse#stderr) does not necessarily indicate success, and a
non-empty [BashToolResponse.Stderr](/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Responses/BashToolResponse#stderr) does not necessarily indicate failure. Check
the actual content and context to determine the command's success.

### <Icon icon="tag" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Stdout

Gets or sets the standard output (stdout) from the executed command.

#### Syntax

```csharp theme={"dark"}
public string Stdout { get; set; }
```

#### Property Value

Type: `string`

#### Remarks

This contains all text written to stdout by the command. On Windows, line endings
will typically be CRLF (`\r\n`), while on Unix-like systems they will be LF (`\n`).

If the output exceeds 30,000 characters, it will be truncated by Claude Code.

For commands that produce binary output (like image generation), this may be empty
and [BashToolResponse.IsImage](/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Responses/BashToolResponse#isimage) will be `true`.

## Methods

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name  | Type      | Description |
| ----- | --------- | ----------- |
| `obj` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> Equals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name   | Type      | Description |
| ------ | --------- | ----------- |
| `objA` | `object?` | -           |
| `objB` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GetHashCode <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> GetType <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### <Icon icon="function" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> MemberwiseClone <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### <Icon icon="thumbtack" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ReferenceEquals <Badge color="gray">Inherited</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name   | Type      | Description |
| ------ | --------- | ----------- |
| `objA` | `object?` | -           |
| `objB` | `object?` | -           |

#### Returns

Type: `bool`

### <Icon icon="code-fork" iconType="duotone" color="#419AC5" size={24} className="mr-2" /> ToString <Badge color="gray">Inherited</Badge> <Badge color="orange">Virtual</Badge>

<Note>Inherited from `object`</Note>

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`