BashToolInput

Represents the input parameters for the Bash tool. The Bash tool executes shell commands in a persistent bash session.

Definition

Assembly: CloudNimble.ClaudeEssentials.dll

Namespace: CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs

Inheritance: System.Object

Syntax

CloudNimble.ClaudeEssentials.Hooks.Tools.Inputs.BashToolInput

Summary

Represents the input parameters for the Bash tool. The Bash tool executes shell commands in a persistent bash session.

Remarks

This tool is for terminal operations like git, npm, docker, etc.

If the output exceeds 30000 characters, it will be truncated.

Constructors

.ctor

Syntax

public BashToolInput()

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Command

Gets or sets the command to execute.

Syntax

public string Command { get; set; }

Property Value

Type: string

DangerouslyDisableSandbox

Gets or sets whether to dangerously override sandbox mode and run commands without sandboxing.

Syntax

public System.Nullable<bool> DangerouslyDisableSandbox { get; set; }

Property Value

Type: System.Nullable<bool>

Description

Gets or sets a clear, concise description of what this command does in 5-10 words.

Syntax

public string Description { get; set; }

Property Value

Type: string?

Remarks

Should be in active voice. For example: “List files in current directory” or “Install package dependencies”.

RunInBackground

Gets or sets whether to run this command in the background.

Syntax

public System.Nullable<bool> RunInBackground { get; set; }

Property Value

Type: System.Nullable<bool>

Remarks

When true, you can monitor the output using subsequent Bash tool calls. You do not need to use ’&’ at the end of the command when using this parameter.

Timeout

Gets or sets the optional timeout in milliseconds.

Syntax

public System.Nullable<int> Timeout { get; set; }

Property Value

Type: System.Nullable<int>

Remarks

Maximum is 600000 (10 minutes). Default is 120000 (2 minutes).

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
obj	object?	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?