com.agentclientprotocol.sdk.agent

类 Command

java.lang.Object

com.agentclientprotocol.sdk.agent.Command

public class Command
extends java.lang.Object

Builder for terminal command execution via the convenience API.

This record allows configuring command execution with options like working directory, environment variables, and output limits.

Example usage:

 // Simple command
 CommandResult result = context.execute("echo", "hello");

 // Command with options
 CommandResult result = context.execute(
     Command.of("make", "build")
         .cwd("/workspace")
         .env(Map.of("DEBUG", "true"))
         .outputLimit(10000));
 

从以下版本开始:

0.9.2

另请参阅:

SyncPromptContext.execute(Command), PromptContext.execute(Command)

构造器概要

构造器

构造器和说明
Command(java.lang.String executable, java.util.List<java.lang.String> args, java.lang.String cwd, java.util.Map<java.lang.String,java.lang.String> env, java.lang.Long outputByteLimit)

方法概要

限定符和类型	方法和说明
java.util.List<java.lang.String>	args()
java.lang.String	cwd()
Command	cwd(java.lang.String cwd) Returns a new Command with the specified working directory.
java.util.Map<java.lang.String,java.lang.String>	env()
Command	env(java.util.Map<java.lang.String,java.lang.String> env) Returns a new Command with the specified environment variables.
java.lang.String	executable()
static Command	of(java.lang.String... commandAndArgs) Creates a Command from command-line arguments.
java.lang.Long	outputByteLimit()
Command	outputByteLimit(long limit) Returns a new Command with the specified output byte limit.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

Command

public Command(java.lang.String executable,
               java.util.List<java.lang.String> args,
               java.lang.String cwd,
               java.util.Map<java.lang.String,java.lang.String> env,
               java.lang.Long outputByteLimit)

参数:

executable - The command to execute

args - The arguments to pass to the command

cwd - The working directory (null for default)

env - Environment variables to set (null for default)

outputByteLimit - Maximum bytes of output to capture (null for default)

方法详细资料

executable

public java.lang.String executable()

args

public java.util.List<java.lang.String> args()

cwd

public java.lang.String cwd()

env

public java.util.Map<java.lang.String,java.lang.String> env()

outputByteLimit

public java.lang.Long outputByteLimit()

of

public static Command of(java.lang.String... commandAndArgs)

Creates a Command from command-line arguments. The first argument is the executable, remaining arguments are passed as args.

参数:

commandAndArgs - The command and its arguments

返回:

A new Command instance

cwd

public Command cwd(java.lang.String cwd)

Returns a new Command with the specified working directory.

参数:

cwd - The working directory

返回:

A new Command with the working directory set

env

public Command env(java.util.Map<java.lang.String,java.lang.String> env)

Returns a new Command with the specified environment variables.

参数:

env - The environment variables

返回:

A new Command with the environment variables set

outputByteLimit

public Command outputByteLimit(long limit)

Returns a new Command with the specified output byte limit.

参数:

limit - The maximum bytes of output to capture

返回:

A new Command with the output byte limit set