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

# KillShellToolResponse

> Represents the response payload returned by the Claude Code KillShell tool after             attempting to terminate a background shell process.

## Definition

**Assembly:** CloudNimble.ClaudeEssentials.dll

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

**Inheritance:** System.Object

## Syntax

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

## Summary

Represents the response payload returned by the Claude Code KillShell tool after
attempting to terminate a background shell process.

## Remarks

The KillShell tool terminates running background bash shells by their ID. Background
shells are created when using the [BashToolInput.RunInBackground](/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Inputs/BashToolInput#runinbackground) parameter.
This response is received in the [KillShellPostToolUsePayload](/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/KillShellPostToolUsePayload)
when the `tool_name` is "KillShell".

Background shells are useful for long-running processes like development servers,
file watchers, or build processes that need to run while other work continues.
The KillShell tool provides a way to gracefully terminate these processes when
they are no longer needed.

Shell IDs can be found using the `/tasks` command in Claude Code.

Example JSON payload (successful):

```csharp theme={"dark"}
{
"shellId": "shell_abc123",
"success": true
}
```

Example JSON payload (failed):

```csharp theme={"dark"}
{
"shellId": "shell_invalid",
"success": false,
"error": "Shell not found or already terminated"
}
```

## Constructors

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

#### Syntax

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

### <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" /> Error

Gets or sets the error message if the kill operation failed.

#### Syntax

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

#### Property Value

Type: `string?`

#### Examples

```csharp theme={"dark"}
"Shell not found or already terminated"
```

#### Remarks

This property is populated when [KillShellToolResponse.Success](/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Responses/KillShellToolResponse#success) is `false`.
Common error scenarios include:

* The shell ID does not exist
* The shell has already been terminated
* The shell process could not be killed due to system restrictions
* The shell ID format is invalid

  When [KillShellToolResponse.Success](/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Responses/KillShellToolResponse#success) is `true`, this property will be `null`.

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

Gets or sets the identifier of the shell that was targeted for termination.

#### Syntax

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

#### Property Value

Type: `string`

#### Examples

```csharp theme={"dark"}
"shell_abc123xyz"
```

#### Remarks

This is the shell ID that was provided in [KillShellToolInput.ShellId](/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Inputs/KillShellToolInput#shellid).
Shell IDs are assigned when background shells are created and follow the format
`"shell_"` followed by a unique identifier.

Available shell IDs can be discovered using the `/tasks` command in Claude Code.

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

Gets or sets a value indicating whether the shell was successfully terminated.

#### Syntax

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

#### Property Value

Type: `bool`

#### Remarks

When `true`, the shell process was found and terminated successfully.
The shell is no longer running and its resources have been released.

When `false`, the termination failed. Check the [KillShellToolResponse.Error](/claudeessentials/api-reference/CloudNimble/ClaudeEssentials/Hooks/Tools/Responses/KillShellToolResponse#error) property
for details about why the operation failed.

## 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?`