claude-code-sdk-rust 0.2.0

Async Rust SDK for the Claude Code CLI: streaming agent turns, tool use, and sessions.
Documentation 
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

//! Session management for Claude Agent SDK.

use crate::error::Result;
use crate::internal::sessions_fs;
use serde::{Deserialize, Serialize};

pub mod store;
pub use store::*;
pub mod store_fork;
pub use store_fork::*;
pub mod import;
pub use import::*;
pub mod local_fork;
pub use local_fork::*;

/// Information about a Claude session.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SessionInfo {
    pub id: String,
    pub title: String,
    pub created_at: String,
    pub updated_at: String,
    pub message_count: usize,
}

/// A message within a session.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SessionMessage {
    pub id: String,
    pub role: String,
    pub content: String,
    pub timestamp: String,
}

/// Options for listing sessions.
#[derive(Debug, Clone, Default)]
pub struct ListSessionsOptions {
    pub directory: Option<String>,
    pub limit: Option<usize>,
    pub offset: Option<usize>,
}

/// Options for querying sessions.
#[derive(Debug, Clone)]
pub struct SessionQueryOptions {
    pub session_id: String,
    pub include_messages: bool,
    pub directory: Option<String>,
    pub limit: Option<usize>,
    pub offset: Option<usize>,
}

/// Options for mutating sessions.
#[derive(Debug, Clone)]
pub struct SessionMutationOptions {
    pub session_id: String,
    pub directory: Option<String>,
}

/// List all available sessions.
pub async fn list_sessions(opts: &ListSessionsOptions) -> Result<Vec<SessionInfo>> {
    sessions_fs::list_sessions(opts).await
}

/// Get information about a specific session.
pub async fn get_session_info(session_id: &str, opts: &SessionQueryOptions) -> Result<SessionInfo> {
    sessions_fs::get_session_info(session_id, opts.directory.as_deref()).await
}

/// Get all messages for a specific session.
pub async fn get_session_messages(
    session_id: &str,
    opts: &SessionQueryOptions,
) -> Result<Vec<SessionMessage>> {
    sessions_fs::get_session_messages(
        session_id,
        opts.directory.as_deref(),
        opts.limit,
        opts.offset.unwrap_or(0),
    )
    .await
}

/// List subagent IDs for a specific session.
pub async fn list_subagents(session_id: &str, opts: &SessionQueryOptions) -> Result<Vec<String>> {
    sessions_fs::list_subagents(session_id, opts.directory.as_deref()).await
}

/// Get messages for a specific subagent transcript.
pub async fn get_subagent_messages(
    session_id: &str,
    agent_id: &str,
    opts: &SessionQueryOptions,
) -> Result<Vec<SessionMessage>> {
    sessions_fs::get_subagent_messages(
        session_id,
        agent_id,
        opts.directory.as_deref(),
        opts.limit,
        opts.offset.unwrap_or(0),
    )
    .await
}

/// Rename a session.
pub async fn rename_session(
    session_id: &str,
    title: &str,
    opts: &SessionMutationOptions,
) -> Result<()> {
    sessions_fs::rename_session(session_id, title, opts.directory.as_deref()).await
}

/// Tag a session. Pass `None` to clear the tag.
pub async fn tag_session(
    session_id: &str,
    tag: Option<&str>,
    opts: &SessionMutationOptions,
) -> Result<()> {
    sessions_fs::tag_session(session_id, tag, opts.directory.as_deref()).await
}

/// Fork a local session transcript into a new session file.
pub async fn fork_session(
    session_id: &str,
    opts: &SessionMutationOptions,
    up_to_message_id: Option<&str>,
    title: Option<&str>,
) -> Result<LocalForkSessionResult> {
    local_fork::fork_session(
        session_id,
        opts.directory.as_deref(),
        up_to_message_id,
        title,
    )
    .await
}

/// Delete a session.
pub async fn delete_session(session_id: &str, opts: &SessionMutationOptions) -> Result<()> {
    sessions_fs::delete_session(session_id, opts.directory.as_deref()).await
}