1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
//! # Claude Agent SDK for Rust
//!
//! Rust SDK for interacting with Claude Code CLI, enabling programmatic access to Claude's
//! capabilities with full bidirectional streaming support and 100% feature parity with the
//! official Python SDK.
//!
//! ## Features
//!
//! - **Simple Query API**: One-shot queries with both collecting ([`query()`]) and streaming ([`query_stream()`]) modes
//! - **Bidirectional Streaming**: Real-time streaming communication with [`ClaudeClient`]
//! - **Dynamic Control**: Interrupt, change permissions, switch models mid-execution
//! - **Hooks System**: Intercept and control Claude's behavior at runtime with 6 hook types
//! - **Custom Tools**: In-process MCP servers with ergonomic [`tool!`](crate::tool) macro
//! - **Plugin System**: Load custom plugins to extend Claude's capabilities
//! - **Permission Management**: Fine-grained control over tool execution
//! - **Cost Control**: Budget limits and fallback models for production reliability
//! - **Extended Thinking**: Configure maximum thinking tokens for complex reasoning
//! - **Session Management**: Resume, fork, and manage conversation sessions
//! - **Multimodal Input**: Send images alongside text using base64 or URLs
//!
//! ## Quick Start
//!
//! ### Simple Query
//!
//! ```no_run
//! use claude_agent_sdk::{query, Message, ContentBlock};
//!
//! #[tokio::main]
//! async fn main() -> anyhow::Result<()> {
//! // One-shot query that collects all messages
//! let messages = query("What is 2 + 2?", None).await?;
//!
//! for message in messages {
//! if let Message::Assistant(msg) = message {
//! for block in &msg.message.content {
//! if let ContentBlock::Text(text) = block {
//! println!("Claude: {}", text.text);
//! }
//! }
//! }
//! }
//!
//! Ok(())
//! }
//! ```
//!
//! ### Streaming Query
//!
//! ```no_run
//! use claude_agent_sdk::{query_stream, Message, ContentBlock};
//! use futures::StreamExt;
//!
//! #[tokio::main]
//! async fn main() -> anyhow::Result<()> {
//! // Streaming query for memory-efficient processing
//! let mut stream = query_stream("Explain Rust ownership", None).await?;
//!
//! while let Some(result) = stream.next().await {
//! let message = result?;
//! if let Message::Assistant(msg) = message {
//! for block in &msg.message.content {
//! if let ContentBlock::Text(text) = block {
//! println!("Claude: {}", text.text);
//! }
//! }
//! }
//! }
//!
//! Ok(())
//! }
//! ```
//!
//! ### Bidirectional Client
//!
//! ```no_run
//! use claude_agent_sdk::{ClaudeClient, ClaudeAgentOptions, Message, PermissionMode};
//! use futures::StreamExt;
//!
//! #[tokio::main]
//! async fn main() -> anyhow::Result<()> {
//! let options = ClaudeAgentOptions::builder()
//! .permission_mode(PermissionMode::BypassPermissions)
//! .max_turns(5)
//! .build();
//!
//! let mut client = ClaudeClient::new(options);
//! client.connect().await?;
//!
//! // Send query
//! client.query("What is Rust?").await?;
//!
//! // Receive responses
//! {
//! let mut stream = client.receive_response();
//! while let Some(result) = stream.next().await {
//! match result? {
//! Message::Assistant(msg) => {
//! println!("Got assistant message");
//! }
//! Message::Result(_) => break,
//! _ => {}
//! }
//! }
//! } // stream is dropped here
//!
//! client.disconnect().await?;
//! Ok(())
//! }
//! ```
//!
//! ## Multimodal Input (Images)
//!
//! The SDK supports sending images alongside text in your prompts using structured content blocks.
//! Both base64-encoded images and URL references are supported.
//!
//! ### Supported Formats
//!
//! - JPEG (`image/jpeg`)
//! - PNG (`image/png`)
//! - GIF (`image/gif`)
//! - WebP (`image/webp`)
//!
//! ### Size Limits
//!
//! - Maximum base64 data size: 15MB (results in ~20MB decoded)
//! - Large images may timeout or fail - resize before encoding
//!
//! ### Example: Query with Image
//!
//! ```no_run
//! use claude_agent_sdk::{query_with_content, UserContentBlock, Message, ContentBlock};
//!
//! #[tokio::main]
//! async fn main() -> anyhow::Result<()> {
//! // For real usage, load and base64-encode an image file
//! // This example uses a pre-encoded 1x1 red PNG pixel
//! let base64_data = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8DwHwAFBQIAX8jx0gAAAABJRU5ErkJggg==";
//!
//! // Query with text and image
//! let messages = query_with_content(vec![
//! UserContentBlock::text("What color is this image?"),
//! UserContentBlock::image_base64("image/png", base64_data)?,
//! ], None).await?;
//!
//! for message in messages {
//! if let Message::Assistant(msg) = message {
//! for block in &msg.message.content {
//! if let ContentBlock::Text(text) = block {
//! println!("Claude: {}", text.text);
//! }
//! }
//! }
//! }
//!
//! Ok(())
//! }
//! ```
//!
//! ### Example: Using Image URLs
//!
//! ```no_run
//! use claude_agent_sdk::{query_with_content, UserContentBlock};
//!
//! #[tokio::main]
//! async fn main() -> anyhow::Result<()> {
//! let messages = query_with_content(vec![
//! UserContentBlock::text("Describe this architecture diagram"),
//! UserContentBlock::image_url("https://example.com/diagram.png"),
//! ], None).await?;
//!
//! Ok(())
//! }
//! ```
//!
//! ### Example: Streaming with Images
//!
//! ```no_run
//! use claude_agent_sdk::{query_stream_with_content, UserContentBlock, Message, ContentBlock};
//! use futures::StreamExt;
//!
//! #[tokio::main]
//! async fn main() -> anyhow::Result<()> {
//! // Minimal 1x1 PNG for example purposes
//! let png_base64 = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==";
//!
//! let mut stream = query_stream_with_content(vec![
//! UserContentBlock::image_base64("image/png", png_base64)?,
//! UserContentBlock::text("What's in this image?"),
//! ], None).await?;
//!
//! while let Some(result) = stream.next().await {
//! let message = result?;
//! if let Message::Assistant(msg) = message {
//! for block in &msg.message.content {
//! if let ContentBlock::Text(text) = block {
//! print!("{}", text.text);
//! }
//! }
//! }
//! }
//!
//! Ok(())
//! }
//! ```
//!
//! ## Configuration
//!
//! The SDK provides extensive configuration through [`ClaudeAgentOptions`]:
//!
//! ```no_run
//! use claude_agent_sdk::{ClaudeAgentOptions, PermissionMode, SdkPluginConfig};
//!
//! let options = ClaudeAgentOptions::builder()
//! .model("claude-opus-4")
//! .fallback_model("claude-sonnet-4")
//! .max_budget_usd(10.0)
//! .max_thinking_tokens(2000)
//! .max_turns(10)
//! .permission_mode(PermissionMode::Default)
//! .plugins(vec![SdkPluginConfig::local("./my-plugin")])
//! .build();
//! ```
//!
//! ## Examples
//!
//! The SDK includes 22 comprehensive examples covering all features. See the
//! [examples directory](https://github.com/yourusername/claude-agent-sdk-rs/tree/master/examples)
//! for detailed usage patterns.
//!
//! ## Documentation
//!
//! - [README](https://github.com/yourusername/claude-agent-sdk-rs/blob/master/README.md) - Getting started
//! - [Plugin Guide](https://github.com/yourusername/claude-agent-sdk-rs/blob/master/PLUGIN_GUIDE.md) - Plugin development
//! - [Examples](https://github.com/yourusername/claude-agent-sdk-rs/tree/master/examples) - 22 working examples
// Re-export commonly used types
pub use ;
pub use ;
pub use ;
pub use ;
pub use ;
pub use ;
pub use ;
pub use ;
pub use ;
// Re-export public API
pub use ClaudeClient;
pub use ;
// Re-export transport types for buffer metrics
pub use BufferMetricsSnapshot;
// Re-export connection pool types
pub use ;
// Re-export parsing mode for performance tuning
pub use ParsingMode;
// Re-export V2 API
pub use ;