Struct RunOptions 

pub struct RunOptions {

    pub cli: Option<CliName>,
    pub task: String,
    pub system_prompt: Option<String>,
    pub system_prompt_file: Option<String>,
    pub mcp_servers: Option<HashMap<String, McpServer>>,
    pub cwd: Option<String>,
    pub model: Option<String>,
    pub idle_timeout_ms: Option<u64>,
    pub total_timeout_ms: Option<u64>,
    pub max_consecutive_tool_failures: Option<u32>,
    pub env: Option<HashMap<String, String>>,
    pub executable_path: Option<String>,
    pub resume_session_id: Option<String>,
    pub max_output_bytes: Option<usize>,
    pub skip_permissions: bool,
    pub providers: Option<ProviderOptions>,
}

Options passed to run().

Fields

cli: Option<CliName>

Which CLI to use. If None, auto-discovers the first available.

task: String

The task/prompt to send to the agent.

system_prompt: Option<String>

System prompt (where supported).

system_prompt_file: Option<String>

Path to a system prompt file (alternative to inline system_prompt).

mcp_servers: Option<HashMap<String, McpServer>>

MCP servers to connect.

cwd: Option<String>

Working directory for the CLI process.

model: Option<String>

Model name (e.g. “sonnet”, “opus”, “o3”).

idle_timeout_ms: Option<u64>

Idle timeout in milliseconds. Default: 300_000 (5 minutes).

total_timeout_ms: Option<u64>

Total timeout in milliseconds. No default.

max_consecutive_tool_failures: Option<u32>

Max consecutive tool failures before aborting. Default: 3.

env: Option<HashMap<String, String>>

Extra environment variables for the CLI process.

executable_path: Option<String>

Explicit path to the CLI executable (skips discovery).

resume_session_id: Option<String>

Session ID to resume a previous conversation.

max_output_bytes: Option<usize>

Maximum bytes to buffer from CLI stdout before aborting.

Prevents OOM if the CLI produces unexpectedly large output. Defaults to 10 MB when None.

skip_permissions: bool

Skip permission prompts and run in fully autonomous mode.

When true, passes provider-specific flags to bypass interactive approval (e.g. --dangerously-skip-permissions for Claude). Use with caution — the agent will be able to execute tools without human confirmation.

Defaults to false.

providers: Option<ProviderOptions>

Provider-specific options.

Trait Implementations

impl Clone for RunOptions

fn clone(&self) -> RunOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunOptions

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

Formats the value using the given formatter.

impl Default for RunOptions

fn default() -> RunOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RunOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RunOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.