agents-ext/ai.koog.agents.ext.tool.shell/ExecuteShellCommandTool

ExecuteShellCommandTool

class ExecuteShellCommandTool(executor: ShellCommandExecutor, confirmationHandler: ShellCommandConfirmationHandler) : Tool<ExecuteShellCommandTool.Args, ExecuteShellCommandTool.Result> (source)

Executes shell commands with user approval and automatic timeout.

Before running any command, asks the user for confirmation. If approved, runs the command and captures everything it prints. If the command takes too long, cancels it automatically.

Constructors

constructor(executor: ShellCommandExecutor, confirmationHandler: ShellCommandConfirmationHandler)

Types

Args

@Serializable

data class Args(val command: String, val timeoutSeconds: Int, val workingDirectory: String? = null)

Parameters for running a shell command.

Result

@Serializable

data class Result(val command: String, val exitCode: Int?, val output: String)

Result of attempting to run a command.

Properties

argsSerializer

open override val argsSerializer: KSerializer<ExecuteShellCommandTool.Args>

description

open override val description: String

descriptor

open val descriptor: ToolDescriptor

name

open override val name: String

resultSerializer

open override val resultSerializer: KSerializer<ExecuteShellCommandTool.Result>

Functions

decodeArgs

fun decodeArgs(rawArgs: JsonObject): ExecuteShellCommandTool.Args

decodeResult

fun decodeResult(rawResult: JsonElement): ExecuteShellCommandTool.Result

encodeArgs

fun encodeArgs(args: ExecuteShellCommandTool.Args): JsonObject

encodeArgsToString

fun encodeArgsToString(args: ExecuteShellCommandTool.Args): String

encodeArgsToStringUnsafe

fun encodeArgsToStringUnsafe(args: Any?): String

encodeArgsUnsafe

fun encodeArgsUnsafe(args: Any?): JsonObject

encodeResult

fun encodeResult(result: ExecuteShellCommandTool.Result): JsonElement

encodeResultToString

open override fun encodeResultToString(result: ExecuteShellCommandTool.Result): String

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: Any?): String

encodeResultUnsafe

fun encodeResultUnsafe(result: Any?): JsonElement

execute

open suspend override fun execute(args: ExecuteShellCommandTool.Args): ExecuteShellCommandTool.Result

Runs a command after asking the user for permission.

executeUnsafe

suspend fun executeUnsafe(args: Any?): ExecuteShellCommandTool.Result