examples/

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ethpandaops/codex-agent-sdk-go

Links

Open Source Insights

README ¶

Examples

This directory contains examples demonstrating the Claude Agent SDK for Go.

API Overview

The SDK provides two main APIs for interacting with Claude:

Top-Level Functions (One-Shot)

Simple, stateless functions for single queries:

Query(ctx, prompt, ...opts) - Send a single prompt and receive streaming responses
QueryStream(ctx, messages, ...opts) - Send multiple messages via iter.Seq[StreamingMessage]

These are ideal for:

Simple question/answer interactions
Batch processing where each query is independent
Scripts and CLI tools

Client API (Stateful)

A stateful client for multi-turn conversations and advanced control:

NewClient() - Create a new client instance
client.Start(ctx, ...opts) - Initialize the connection
client.Query(ctx, prompt) - Send a message (conversation context preserved)
client.ReceiveMessages(ctx) / client.ReceiveResponse(ctx) - Receive responses
client.Interrupt(ctx) - Interrupt an ongoing response
client.Close() - Clean up resources

This is ideal for:

Multi-turn conversations with context
Interactive applications
Scenarios requiring interrupt capability

Examples

Example	Description
`quick_start`	Basic usage of the `Query()` function
`query_stream`	Using `QueryStream()` with `iter.Seq[StreamingMessage]`
`client_multi_turn`	Client API with multi-turn conversations, interrupts, and advanced patterns
`sessions`	Managing conversation sessions
`agents`	Building custom agents
`filesystem_agents`	File system operations with agents
`mcp_calculator`	MCP server integration
`plugin_example`	Plugin system usage
`system_prompt`	Customizing system prompts
`tools_option`	Configuring allowed tools
`sdk_tools`	SDK-defined tools with `WithSDKTools` and `NewTool`
`tool_permission_callback`	Custom tool permission handling
`stderr_callback`	Capturing CLI stderr output
`custom_logger`	Custom logging configuration
`max_budget_usd`	Setting cost limits
`setting_sources`	Configuration sources
`include_partial_messages`	Handling partial/streaming messages
`structured_output`	Using `WithOutputFormat()` for structured JSON responses
`parallel_queries`	Running concurrent `Query()` calls with errgroup
`pipeline`	Multi-step LLM orchestration with Go control flow

Running Examples

# Run a specific example
go run ./examples/quick_start

# Run client_multi_turn with a specific sub-example
go run ./examples/client_multi_turn basic_streaming
go run ./examples/client_multi_turn all

Directories ¶

Path	Synopsis
cancellation
client_multi_turn
custom_logger Package main demonstrates how to use a custom logging library (logrus) with the Codex SDK.	Package main demonstrates how to use a custom logging library (logrus) with the Codex SDK.
error_handling
extended_thinking
include_partial_messages
max_budget_usd
mcp_calculator Package main demonstrates how to create calculator tools using MCP servers.	Package main demonstrates how to create calculator tools using MCP servers.
mcp_status Package main demonstrates querying MCP server connection status.	Package main demonstrates querying MCP server connection status.
memory_tool Package main demonstrates a filesystem-backed memory tool for agent state persistence.	Package main demonstrates a filesystem-backed memory tool for agent state persistence.
parallel_queries
pipeline
query_stream
quick_start
sdk_tools Package main demonstrates the high-level Tool API with WithSDKTools.	Package main demonstrates the high-level Tool API with WithSDKTools.
sessions
stderr_callback
structured_output
system_prompt
tool_permission_callback
tools_option

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL