Skip to main content

Module config

Module config 

Source
Expand description

Client configuration — ClientConfig with typed builder pattern.

ClientConfig carries every option needed to spawn and control a Claude Code CLI session. It uses typed_builder so that required fields must be supplied at compile time while optional fields have sensible defaults.

§Example

use claude_cli_sdk::config::{ClientConfig, PermissionMode};

let config = ClientConfig::builder()
    .prompt("List files in /tmp")
    .build();

Structs§

ClientConfig
Configuration for a Claude Code SDK client session.

Enums§

PermissionMode
Permission mode controlling how tool use requests are handled.
SystemPrompt
System prompt configuration for a Claude session.

Constants§

INPUT_FORMAT_STREAM_JSON
The stream-json input format value for ClientConfig::input_format.
OUTPUT_FORMAT_STREAM_JSON
The stream-json output format value for ClientConfig::output_format.