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

# EnterWorktreePreToolUsePayload

> Represents the complete payload delivered to a PreToolUse hook when the EnterWorktree tool is about to be invoked.

## Definition

**Assembly:** CloudNimble.ClaudeEssentials.dll

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

**Inheritance:** CloudNimble.ClaudeEssentials.Hooks.Inputs.PreToolUseHookInput\<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.EnterWorktreeToolInput>

## Syntax

```csharp theme={null}
CloudNimble.ClaudeEssentials.Hooks.Tools.EnterWorktreePreToolUsePayload
```

## Summary

Represents the complete payload delivered to a PreToolUse hook when the EnterWorktree tool is about to be invoked.

## Remarks

The EnterWorktree tool creates a temporary git worktree for isolated work. Your hook can
inspect the optional worktree name before it is created.

## Constructors

### &#x20;.ctor

#### Syntax

```csharp theme={null}
public EnterWorktreePreToolUsePayload()
```

### &#x20;.ctor Inherited

> [!NOTE]
>
> Inherited from `CloudNimble.ClaudeEssentials.Hooks.Inputs.PreToolUseHookInput<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.EnterWorktreeToolInput>`

#### Syntax

```csharp theme={null}
public PreToolUseHookInput()
```

### &#x20;.ctor Inherited

> [!NOTE]
>
> Inherited from `CloudNimble.ClaudeEssentials.Hooks.Inputs.ToolHookInputBase<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.EnterWorktreeToolInput>`

#### Syntax

```csharp theme={null}
protected ToolHookInputBase()
```

### &#x20;.ctor Inherited

> [!NOTE]
>
> Inherited from `CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase`

#### Syntax

```csharp theme={null}
protected HookInputBase()
```

### &#x20;.ctor Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={null}
public Object()
```

## Properties

### &#x20;CurrentWorkingDirectory Inherited

> [!NOTE]
>
> Inherited from `CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase`

Gets or sets the current working directory where Claude Code is running.

#### Syntax

```csharp theme={null}
public string CurrentWorkingDirectory { get; set; }
```

#### Property Value

Type: `string`

### &#x20;HookEventName Inherited

> [!NOTE]
>
> Inherited from `CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase`

Gets or sets the name of the hook event that triggered this input.

#### Syntax

```csharp theme={null}
public CloudNimble.ClaudeEssentials.Hooks.HookEventName HookEventName { get; set; }
```

#### Property Value

Type: `CloudNimble.ClaudeEssentials.Hooks.HookEventName`

### &#x20;PermissionMode Inherited

> [!NOTE]
>
> Inherited from `CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase`

Gets or sets the permission mode under which Claude Code is operating.

#### Syntax

```csharp theme={null}
public CloudNimble.ClaudeEssentials.Hooks.PermissionMode PermissionMode { get; set; }
```

#### Property Value

Type: `CloudNimble.ClaudeEssentials.Hooks.PermissionMode`

### &#x20;SessionId Inherited

> [!NOTE]
>
> Inherited from `CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase`

Gets or sets the unique identifier for the current Claude Code session.

#### Syntax

```csharp theme={null}
public string SessionId { get; set; }
```

#### Property Value

Type: `string`

### &#x20;ToolInput Inherited

> [!NOTE]
>
> Inherited from `CloudNimble.ClaudeEssentials.Hooks.Inputs.ToolHookInputBase<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.EnterWorktreeToolInput>`

Gets or sets the input parameters for the tool.
The schema depends on the specific tool being invoked.

#### Syntax

```csharp theme={null}
public CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.EnterWorktreeToolInput ToolInput { get; set; }
```

#### Property Value

Type: `CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.EnterWorktreeToolInput?`

### &#x20;ToolName Inherited

> [!NOTE]
>
> Inherited from `CloudNimble.ClaudeEssentials.Hooks.Inputs.ToolHookInputBase<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.EnterWorktreeToolInput>`

Gets or sets the name of the tool being invoked.
Common tool names include: Write, Edit, Bash, Read, Grep, Glob, Task, WebFetch, WebSearch.
MCP tools follow the pattern: mcp\_\_\<server>\_\_\<tool>.

#### Syntax

```csharp theme={null}
public string ToolName { get; set; }
```

#### Property Value

Type: `string`

### &#x20;ToolUseId Inherited

> [!NOTE]
>
> Inherited from `CloudNimble.ClaudeEssentials.Hooks.Inputs.ToolHookInputBase<CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.EnterWorktreeToolInput>`

Gets or sets the unique identifier for this specific tool use instance.
Typically follows the pattern: toolu\_01ABC123...

#### Syntax

```csharp theme={null}
public string ToolUseId { get; set; }
```

#### Property Value

Type: `string`

### &#x20;TranscriptPath Inherited

> [!NOTE]
>
> Inherited from `CloudNimble.ClaudeEssentials.Hooks.Inputs.HookInputBase`

Gets or sets the file path to the transcript JSONL file for the current session.
This file contains the full conversation history.

#### Syntax

```csharp theme={null}
public string TranscriptPath { get; set; }
```

#### Property Value

Type: `string`

## Methods

### &#x20;Equals Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

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

#### Parameters

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

#### Returns

Type: `bool`

### &#x20;Equals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

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

#### Parameters

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

#### Returns

Type: `bool`

### &#x20;GetHashCode Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

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

#### Returns

Type: `int`

### &#x20;GetType Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

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

#### Returns

Type: `System.Type`

### &#x20;MemberwiseClone Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

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

#### Returns

Type: `object`

### &#x20;ReferenceEquals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

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

#### Parameters

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

#### Returns

Type: `bool`

### &#x20;ToString Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

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

#### Returns

Type: `string?`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.