Struct AgentTuiOptions 

pub struct AgentTuiOptions {

    pub tool: String,
    pub working_directory: PathBuf,
    pub executable: Option<String>,
    pub prefix_args: Vec<String>,
    pub extra_args: Vec<String>,
    pub extra_env: HashMap<String, String>,
    pub model: Option<String>,
    pub prompt: Option<String>,
    pub system_prompt: Option<String>,
    pub prompt_after: Option<String>,
    pub prompt_key: TerminalKey,
    pub resume: Option<String>,
    pub read_only: bool,
    pub plan_only: bool,
    pub approve_each: bool,
    pub skip_default_safety_flags: bool,
    pub cols: u16,
    pub rows: u16,
    pub settle_duration: Duration,
    pub interactions: Vec<TerminalInteraction>,
    pub stop_marker: Option<String>,
    pub stop_marker_grace: Duration,
    pub timeout: Duration,
    pub artifact_directory: Option<PathBuf>,
}

Options for launching and driving an agent’s real interactive terminal UI.

Fields

tool: String

Agent CLI name.

working_directory: PathBuf

Directory in which the agent runs.

executable: Option<String>

Override for the agent executable.

prefix_args: Vec<String>

Arguments inserted before the generated agent arguments.

extra_args: Vec<String>

Additional agent arguments.

extra_env: HashMap<String, String>

Additional environment variables.

model: Option<String>

Optional model name or alias.

prompt: Option<String>

Initial user prompt.

system_prompt: Option<String>

Optional system prompt.

prompt_after: Option<String>

Marker that must be observed before sending the initial prompt.

prompt_key: TerminalKey

Control key sent after the initial prompt.

resume: Option<String>

Session identifier to resume.

read_only: bool

Request the client’s native read-only mode.

plan_only: bool

Request the client’s native plan-only mode where distinct.

approve_each: bool

Request approval for individual operations.

skip_default_safety_flags: bool

Suppress the default autonomous safety-bypass flags.

cols: u16

Initial terminal width.

rows: u16

Initial terminal height.

settle_duration: Duration

Time without output before a frame is considered settled.

interactions: Vec<TerminalInteraction>

Input, control-key, and resize interactions.

stop_marker: Option<String>

Marker after which the capture process can be stopped.

stop_marker_grace: Duration

Grace period after the stop marker.

timeout: Duration

Overall capture timeout.

artifact_directory: Option<PathBuf>

Directory for transcript, frame, cast, and animation artifacts.

Trait Implementations

impl Clone for AgentTuiOptions

fn clone(&self) -> AgentTuiOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AgentTuiOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AgentTuiOptions

fn default() -> Self

Returns the “default value” for a type.