Struct ClientBuilder

pub struct ClientBuilder { /* private fields */ }

Builder for creating Client instances with fluent configuration

The ClientBuilder provides a convenient way to construct client instances using the builder pattern. All methods are chainable and return self for fluent composition.

Examples

let client = Client::builder()
    .model("claude-3-sonnet-20240229")
    .system_prompt("You are a helpful assistant")
    .stream_format(StreamFormat::Json)
    .timeout_secs(60)
    .build();

Implementations

impl ClientBuilder

pub fn new() -> Self

Create a new client builder with default configuration

pub fn config(self, config: Config) -> Self

Set the configuration directly

This allows you to use a pre-built Config instance instead of configuring individual options.

pub fn system_prompt(self, prompt: impl Into<String>) -> Self

Set the system prompt for the assistant

Examples

let client = Client::builder()
    .system_prompt("You are a Rust expert")
    .build();

pub fn model(self, model: impl Into<String>) -> Self

Set the Claude model to use

Examples

let client = Client::builder()
    .model("claude-3-opus-20240229")
    .build();

pub fn allowed_tools(self, tools: Vec<String>) -> Self

Set the list of allowed tools

Examples

let client = Client::builder()
    .allowed_tools(vec!["bash".to_string(), "filesystem".to_string()])
    .build();

pub fn stream_format(self, format: StreamFormat) -> Self

Set the output format for responses

Examples

let client = Client::builder()
    .stream_format(StreamFormat::Json)
    .build();

pub fn verbose(self, verbose: bool) -> Self

Enable or disable verbose output

Examples

let client = Client::builder()
    .verbose(true)
    .build();

pub fn timeout_secs(self, timeout_secs: u64) -> Self

Set the timeout in seconds

Examples

let client = Client::builder()
    .timeout_secs(120)  // 2 minute timeout
    .build();

pub fn continue_session(self) -> Self

Enable session continuation (–continue flag)

When enabled, the client will use the –continue flag to resume the most recent conversation session.

Examples

let client = Client::builder()
    .continue_session()
    .build();

pub fn resume_session(self, session_id: impl Into<String>) -> Self

Resume a specific session by ID (–resume flag)

When set, the client will use the –resume flag with the specified session ID to continue a specific conversation session.

Examples

let client = Client::builder()
    .resume_session("session_123")
    .build();

pub fn disallowed_tools(self, tools: Vec<String>) -> Self

Set the list of disallowed tools

Controls which tools Claude cannot access during execution. Provides fine-grained control over tool restrictions.

Examples

let client = Client::builder()
    .disallowed_tools(vec!["bash".to_string(), "filesystem".to_string()])
    .build();

pub fn skip_permissions(self, skip: bool) -> Self

Set whether to skip permission prompts (default: true)

When true (default), adds the --dangerously-skip-permissions flag to bypass tool permission prompts. Set to false for additional security.

Examples

let client = Client::builder()
    .skip_permissions(false)  // Require permission prompts
    .build();

pub fn append_system_prompt(self, prompt: impl Into<String>) -> Self

Set an additional system prompt to append

When set, adds the --append-system-prompt flag to extend the existing system prompt. Cannot be used with system_prompt.

Examples

let client = Client::builder()
    .append_system_prompt("Additionally, be concise in your responses.")
    .build();

pub fn max_turns(self, turns: u32) -> Self

Set the maximum number of conversation turns

Limits the conversation to the specified number of back-and-forth exchanges. Useful for controlling conversation length.

Examples

let client = Client::builder()
    .max_turns(10)
    .build();

pub fn security_level(self, level: SecurityLevel) -> Self

Set the security validation level

Controls how strictly user input is validated for potential security threats.

Examples

let client = Client::builder()
    .security_level(SecurityLevel::Relaxed)  // Allow more flexible input
    .build();

pub fn build(self) -> Result<Client>

Build the final client instance

Examples

let client = Client::builder()
    .model("claude-3-sonnet-20240229")
    .stream_format(StreamFormat::Json)
    .build()
    .expect("valid configuration");

Errors

Returns an error if the configuration is invalid

Trait Implementations

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.