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 exitCode: Int?, val output: String)

Result of attempting to run a command.

Properties

argsType

val argsType: TypeToken

descriptor

val descriptor: ToolDescriptor

metadata

val metadata: Map<String, String>

name

val name: String

resultType

val resultType: TypeToken

Functions

decodeArgs

open fun decodeArgs(rawArgs: JSONObject, serializer: JSONSerializer): ExecuteShellCommandTool.Args

decodeResult

open fun decodeResult(rawResult: JSONElement, serializer: JSONSerializer): ExecuteShellCommandTool.Result

encodeArgs

open fun encodeArgs(args: ExecuteShellCommandTool.Args, serializer: JSONSerializer): JSONObject

encodeArgsToString

fun encodeArgsToString(args: ExecuteShellCommandTool.Args, serializer: JSONSerializer): String

encodeArgsToStringUnsafe

fun encodeArgsToStringUnsafe(args: Any?, serializer: JSONSerializer): String

encodeArgsUnsafe

fun encodeArgsUnsafe(args: Any?, serializer: JSONSerializer): JSONObject

encodeResult

open fun encodeResult(result: ExecuteShellCommandTool.Result, serializer: JSONSerializer): JSONElement

encodeResultToString

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

encodeResultToStringUnsafe

fun encodeResultToStringUnsafe(result: Any?, serializer: JSONSerializer): String

encodeResultUnsafe

fun encodeResultUnsafe(result: Any?, serializer: JSONSerializer): 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