ClaudeCodeOptions

Struct ClaudeCodeOptions 

Source
pub struct ClaudeCodeOptions {
Show 29 fields pub system_prompt_v2: Option<SystemPrompt>, pub system_prompt: Option<String>, pub append_system_prompt: Option<String>, pub allowed_tools: Vec<String>, pub disallowed_tools: Vec<String>, pub permission_mode: PermissionMode, pub mcp_servers: HashMap<String, McpServerConfig>, pub mcp_tools: Vec<String>, pub max_turns: Option<i32>, pub max_thinking_tokens: i32, pub max_output_tokens: Option<u32>, pub model: Option<String>, pub cwd: Option<PathBuf>, pub continue_conversation: bool, pub resume: Option<String>, pub permission_prompt_tool_name: Option<String>, pub settings: Option<String>, pub add_dirs: Vec<PathBuf>, pub extra_args: HashMap<String, Option<String>>, pub env: HashMap<String, String>, pub debug_stderr: Option<Arc<Mutex<dyn Write + Send + Sync>>>, pub include_partial_messages: bool, pub can_use_tool: Option<Arc<dyn CanUseTool>>, pub hooks: Option<HashMap<String, Vec<HookMatcher>>>, pub control_protocol_format: ControlProtocolFormat, pub setting_sources: Option<Vec<SettingSource>>, pub fork_session: bool, pub agents: Option<HashMap<String, AgentDefinition>>, pub cli_channel_buffer_size: Option<usize>,
}
Expand description

Configuration options for Claude Code SDK

Fields§

§system_prompt_v2: Option<SystemPrompt>

System prompt configuration (simplified in v0.1.12+) Can be either a string or a preset configuration Replaces the old system_prompt and append_system_prompt fields

§system_prompt: Option<String>
👎Deprecated since 0.1.12: Use system_prompt_v2 instead

[DEPRECATED] System prompt to prepend to all messages Use system_prompt_v2 instead

§append_system_prompt: Option<String>
👎Deprecated since 0.1.12: Use system_prompt_v2 instead

[DEPRECATED] Additional system prompt to append Use system_prompt_v2 instead

§allowed_tools: Vec<String>

List of allowed tools

§disallowed_tools: Vec<String>

List of disallowed tools

§permission_mode: PermissionMode

Permission mode for tool execution

§mcp_servers: HashMap<String, McpServerConfig>

MCP server configurations

§mcp_tools: Vec<String>

MCP tools to enable

§max_turns: Option<i32>

Maximum number of conversation turns

§max_thinking_tokens: i32

Maximum thinking tokens

§max_output_tokens: Option<u32>

Maximum output tokens per response (1-32000, overrides CLAUDE_CODE_MAX_OUTPUT_TOKENS env var)

§model: Option<String>

Model to use

§cwd: Option<PathBuf>

Working directory

§continue_conversation: bool

Continue from previous conversation

§resume: Option<String>

Resume from a specific conversation ID

§permission_prompt_tool_name: Option<String>

Custom permission prompt tool name

§settings: Option<String>

Settings file path for Claude Code CLI

§add_dirs: Vec<PathBuf>

Additional directories to add as working directories

§extra_args: HashMap<String, Option<String>>

Extra arbitrary CLI flags

§env: HashMap<String, String>

Environment variables to pass to the process

§debug_stderr: Option<Arc<Mutex<dyn Write + Send + Sync>>>

Debug output stream (e.g., stderr)

§include_partial_messages: bool

Include partial assistant messages in streaming output

§can_use_tool: Option<Arc<dyn CanUseTool>>

Tool permission callback

§hooks: Option<HashMap<String, Vec<HookMatcher>>>

Hook configurations

§control_protocol_format: ControlProtocolFormat

Control protocol format (defaults to Legacy for compatibility)

§setting_sources: Option<Vec<SettingSource>>

Setting sources to load (user, project, local) When None, no filesystem settings are loaded (matches Python SDK v0.1.0 behavior)

§fork_session: bool

Fork session when resuming instead of continuing When true, creates a new branch from the resumed session

§agents: Option<HashMap<String, AgentDefinition>>

Programmatic agent definitions Define agents inline without filesystem dependencies

§cli_channel_buffer_size: Option<usize>

CLI channel buffer size for internal communication channels Controls the size of message, control, and stdin buffers (default: 100) Increase for high-throughput scenarios to prevent message lag

Implementations§

Source§

impl ClaudeCodeOptions

Source

pub fn builder() -> ClaudeCodeOptionsBuilder

Create a new options builder

Trait Implementations§

Source§

impl Clone for ClaudeCodeOptions

Source§

fn clone(&self) -> ClaudeCodeOptions

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClaudeCodeOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ClaudeCodeOptions

Source§

fn default() -> ClaudeCodeOptions

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more