ClaudeCodeSDK.Query (claude_code_sdk v0.0.1)
View SourceHandles querying Claude Code and processing responses.
This module is responsible for building the appropriate command-line arguments for different types of Claude Code queries (new queries, continuations, and resumptions) and delegating to the Process module for execution.
All functions in this module return a Stream of ClaudeCodeSDK.Message
structs.
Summary
Functions
Continues the most recent conversation.
Resumes a specific conversation by session ID.
Runs a new query with the given prompt and options.
Functions
@spec continue(String.t() | nil, ClaudeCodeSDK.Options.t()) :: Enumerable.t(ClaudeCodeSDK.Message.t())
Continues the most recent conversation.
Parameters
prompt
- Optional additional prompt to send (string or nil)options
- Configuration options (seeClaudeCodeSDK.Options.t/0
)
Returns
A stream of ClaudeCodeSDK.Message.t/0
structs.
Examples
ClaudeCodeSDK.Query.continue("Add error handling", %ClaudeCodeSDK.Options{})
@spec resume(String.t(), String.t() | nil, ClaudeCodeSDK.Options.t()) :: Enumerable.t(ClaudeCodeSDK.Message.t())
Resumes a specific conversation by session ID.
Parameters
session_id
- The session ID to resume (string)prompt
- Optional additional prompt to send (string or nil)options
- Configuration options (seeClaudeCodeSDK.Options.t/0
)
Returns
A stream of ClaudeCodeSDK.Message.t/0
structs.
Examples
ClaudeCodeSDK.Query.resume("session-123", "Add tests", %ClaudeCodeSDK.Options{})
@spec run(String.t(), ClaudeCodeSDK.Options.t()) :: Enumerable.t(ClaudeCodeSDK.Message.t())
Runs a new query with the given prompt and options.
Parameters
prompt
- The prompt to send to Claude (string)options
- Configuration options (seeClaudeCodeSDK.Options.t/0
)
Returns
A stream of ClaudeCodeSDK.Message.t/0
structs.
Examples
ClaudeCodeSDK.Query.run("Write a hello world function", %ClaudeCodeSDK.Options{})