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
35/// CLI download and management utilities
36pub mod cli_download;
37mod client;
38mod client_working;
39mod errors;
40mod interactive;
41mod internal_query;
42mod message_parser;
43pub mod model_recommendation;
44mod optimized_client;
45/// Session history API
46pub mod sessions;
47mod perf_utils;
48mod query;
49mod sdk_mcp;
50pub mod token_tracker;
51pub mod transport;
52mod types;
53
54// Re-export main types and functions
55pub use client::ClaudeSDKClient;
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 sessions::{SessionInfo, SessionMessage, list_sessions, get_session_messages, rename_session, tag_session, delete_session, fork_session};
66pub use perf_utils::{MessageBatcher, PerformanceMetrics, RetryConfig};
67pub use token_tracker::{BudgetLimit, BudgetManager, BudgetStatus, TokenUsageTracker};
68/// Default interactive client - the recommended client for interactive use
69pub type ClaudeSDKClientDefault = InteractiveClient;
70pub use types::{
71    AssistantContent, AssistantMessage, ClaudeCodeOptions, ContentBlock, ContentValue,
72    ControlProtocolFormat, ControlRequest, ControlResponse, McpServerConfig, Message,
73    PermissionMode, ResultMessage, SystemMessage, TextContent, ThinkingContent,
74    ToolResultContent, ToolUseContent, UserContent, UserMessage,
75    // Permission types
76    PermissionBehavior, PermissionResult, PermissionResultAllow, PermissionResultDeny,
77    PermissionRuleValue, PermissionUpdate, PermissionUpdateDestination, PermissionUpdateType,
78    ToolPermissionContext, CanUseTool,
79    // Hook types (v0.3.0 - strongly-typed hooks)
80    HookCallback, HookContext, HookMatcher,
81    // Hook Input types (strongly-typed)
82    BaseHookInput, HookInput, PreToolUseHookInput, PostToolUseHookInput,
83    PostToolUseFailureHookInput, UserPromptSubmitHookInput, StopHookInput,
84    SubagentStopHookInput, PreCompactHookInput,
85    NotificationHookInput, SubagentStartHookInput, PermissionRequestHookInput,
86    // Hook Output types (strongly-typed)
87    HookJSONOutput, AsyncHookJSONOutput, SyncHookJSONOutput,
88    HookSpecificOutput, PreToolUseHookSpecificOutput, PostToolUseHookSpecificOutput,
89    PostToolUseFailureHookSpecificOutput, UserPromptSubmitHookSpecificOutput,
90    SessionStartHookSpecificOutput, NotificationHookSpecificOutput,
91    SubagentStartHookSpecificOutput, PermissionRequestHookSpecificOutput,
92    // SDK Control Protocol types
93    SDKControlInitializeRequest, SDKControlInterruptRequest, SDKControlMcpMessageRequest,
94    SDKControlPermissionRequest, SDKControlRequest, SDKControlSetPermissionModeRequest,
95    SDKHookCallbackRequest, SDKControlRewindFilesRequest,
96    SDKControlGetContextUsageRequest, SDKControlStopTaskRequest,
97    SDKControlMcpStatusRequest, SDKControlMcpReconnectRequest, SDKControlMcpToggleRequest,
98    // Phase 2 enhancements
99    SettingSource, AgentDefinition, SystemPrompt,
100    // Task message types (Python SDK parity)
101    TaskUsage, TaskStatus, TaskStartedMessage, TaskProgressMessage, TaskNotificationMessage,
102    // Phase 3 enhancements (Python SDK v0.1.12+ sync)
103    ToolsConfig, ToolsPreset, SdkBeta,
104    // v0.7.0 enhancements (Python SDK parity)
105    Effort, RateLimitStatus, RateLimitType, RateLimitInfo, AssistantMessageError,
106    McpConnectionStatus, McpToolAnnotations, McpToolInfo, McpServerInfo, McpServerStatus,
107    ThinkingConfig,
108    SandboxSettings, SandboxNetworkConfig, SandboxIgnoreViolations,
109    SdkPluginConfig,
110    // v0.8.0 enhancements (Python SDK full parity)
111    ContextUsageResponse, ContextUsageCategory, ApiUsage,
112    TaskBudget, ForkSessionResult,
113};
114
115// Phase 3: Type aliases for naming consistency
116/// Alias for ClaudeCodeOptions (matches Python SDK naming)
117pub type ClaudeAgentOptions = ClaudeCodeOptions;
118/// Alias for ClaudeCodeOptionsBuilder (matches Python SDK naming)
119pub type ClaudeAgentOptionsBuilder = ClaudeCodeOptionsBuilder;
120
121// Re-export builder
122pub use types::ClaudeCodeOptionsBuilder;
123
124// Re-export transport types for convenience
125pub use transport::SubprocessTransport;
126#[cfg(feature = "websocket")]
127pub use transport::websocket::{WebSocketTransport, WebSocketConfig};
128
129// Re-export SDK MCP types
130pub use sdk_mcp::{
131    SdkMcpServer, SdkMcpServerBuilder, ToolDefinition, ToolHandler, ToolInputSchema,
132    ToolResult, create_simple_tool,
133    ToolResultContent as SdkToolResultContent,
134};
135
136/// Prelude module for convenient imports
137pub mod prelude {
138    pub use crate::{
139        ClaudeCodeOptions, ClaudeSDKClient, ClaudeSDKClientWorking, Message, PermissionMode,
140        Result, SdkError, query,
141    };
142}
cc_sdk/lib.rs

cc_sdk/
lib.rs
