cc_sdk/
lib.rs

1//! # Claude Code SDK for Rust
2//!
3//! A Rust SDK for interacting with the Claude Code CLI, providing both simple query
4//! and interactive client interfaces.
5//!
6//! ## Features
7//!
8//! - **Simple Query Interface**: One-shot queries with the `query` function
9//! - **Interactive Client**: Stateful conversations with `ClaudeSDKClient`
10//! - **Streaming Support**: Async streaming of responses
11//! - **Type Safety**: Strongly typed messages and errors
12//! - **Flexible Configuration**: Extensive options for customization
13//!
14//! ## Quick Start
15//!
16//! ```rust,no_run
17//! use cc_sdk::{query, Result};
18//! use futures::StreamExt;
19//!
20//! #[tokio::main]
21//! async fn main() -> Result<()> {
22//!     let mut messages = query("What is 2 + 2?", None).await?;
23//!     
24//!     while let Some(msg) = messages.next().await {
25//!         println!("{:?}", msg?);
26//!     }
27//!     
28//!     Ok(())
29//! }
30//! ```
31
32#![warn(missing_docs)]
33#![warn(rustdoc::missing_crate_level_docs)]
34
35mod client;
36// mod client_v2;  // Has compilation errors
37// mod client_final;  // Has compilation errors
38mod client_working;
39mod errors;
40mod interactive;
41mod internal_query;
42mod message_parser;
43pub mod model_recommendation;
44mod optimized_client;
45mod perf_utils;
46mod query;
47mod sdk_mcp;
48pub mod token_tracker;
49pub mod transport;
50mod types;
51
52// Re-export main types and functions
53pub use client::ClaudeSDKClient;
54// pub use client_v2::ClaudeSDKClientV2;  // Has compilation errors
55// pub use client_final::ClaudeSDKClientFinal;  // Has compilation errors
56pub use client_working::ClaudeSDKClientWorking;
57pub use errors::{Result, SdkError};
58pub use interactive::InteractiveClient;
59pub use internal_query::Query;
60pub use query::query;
61// Keep the old name as an alias for backward compatibility
62pub use interactive::InteractiveClient as SimpleInteractiveClient;
63pub use model_recommendation::ModelRecommendation;
64pub use optimized_client::{ClientMode, OptimizedClient};
65pub use perf_utils::{MessageBatcher, PerformanceMetrics, RetryConfig};
66pub use token_tracker::{BudgetLimit, BudgetManager, BudgetStatus, TokenUsageTracker};
67/// Default interactive client - the recommended client for interactive use
68pub type ClaudeSDKClientDefault = InteractiveClient;
69pub use types::{
70    AssistantContent, AssistantMessage, ClaudeCodeOptions, ContentBlock, ContentValue,
71    ControlProtocolFormat, ControlRequest, ControlResponse, McpServerConfig, Message,
72    PermissionMode, ResultMessage, SystemMessage, TextContent, ThinkingContent,
73    ToolResultContent, ToolUseContent, UserContent, UserMessage,
74    // Permission types
75    PermissionBehavior, PermissionResult, PermissionResultAllow, PermissionResultDeny,
76    PermissionRuleValue, PermissionUpdate, PermissionUpdateDestination, PermissionUpdateType,
77    ToolPermissionContext, CanUseTool,
78    // Hook types (v0.3.0 - strongly-typed hooks)
79    HookCallback, HookContext, HookMatcher,
80    // Hook Input types (strongly-typed)
81    BaseHookInput, HookInput, PreToolUseHookInput, PostToolUseHookInput,
82    UserPromptSubmitHookInput, StopHookInput, SubagentStopHookInput, PreCompactHookInput,
83    // Hook Output types (strongly-typed)
84    HookJSONOutput, AsyncHookJSONOutput, SyncHookJSONOutput,
85    HookSpecificOutput, PreToolUseHookSpecificOutput, PostToolUseHookSpecificOutput,
86    UserPromptSubmitHookSpecificOutput, SessionStartHookSpecificOutput,
87    // SDK Control Protocol types
88    SDKControlInitializeRequest, SDKControlInterruptRequest, SDKControlMcpMessageRequest,
89    SDKControlPermissionRequest, SDKControlRequest, SDKControlSetPermissionModeRequest,
90    SDKHookCallbackRequest,
91    // Phase 2 enhancements
92    SettingSource, AgentDefinition, SystemPrompt,
93};
94
95// Phase 3: Type aliases for naming consistency
96/// Alias for ClaudeCodeOptions (matches Python SDK naming)
97pub type ClaudeAgentOptions = ClaudeCodeOptions;
98/// Alias for ClaudeCodeOptionsBuilder (matches Python SDK naming)
99pub type ClaudeAgentOptionsBuilder = ClaudeCodeOptionsBuilder;
100
101// Re-export builder
102pub use types::ClaudeCodeOptionsBuilder;
103
104// Re-export transport types for convenience
105pub use transport::SubprocessTransport;
106
107// Re-export SDK MCP types
108pub use sdk_mcp::{
109    SdkMcpServer, SdkMcpServerBuilder, ToolDefinition, ToolHandler, ToolInputSchema,
110    ToolResult, create_simple_tool,
111    ToolResultContent as SdkToolResultContent,
112};
113
114/// Prelude module for convenient imports
115pub mod prelude {
116    pub use crate::{
117        ClaudeCodeOptions, ClaudeSDKClient, ClaudeSDKClientWorking, Message, PermissionMode,
118        Result, SdkError, query,
119    };
120}
cc_sdk/lib.rs

cc_sdk/
lib.rs
