ClaudeAgentSDK.Query.CLIStream (claude_agent_sdk v0.15.0)

Copy Markdown View Source

Streams CLI-only query responses over a transport.

This module is used for unidirectional, non-control queries. It supports:

  • String prompts (sent as stream-json user messages via stdin)
  • Enumerable prompts (streamed via stdin)
  • Optional transport injection

Summary

Types

transport_spec()

Functions

stream(prompt, options, transport \\ nil)

Streams messages for a single query prompt.

Types

transport_spec()

@type transport_spec() :: module() | {module(), keyword()} | nil

Functions

stream(prompt, options, transport \\ nil)

@spec stream(
  String.t() | Enumerable.t(),
  ClaudeAgentSDK.Options.t(),
  transport_spec()
) ::
  Enumerable.t(ClaudeAgentSDK.Message.t())

Streams messages for a single query prompt.