Module: ClaudeCode

Defined in:
lib/claude_code.rb,
lib/claude_code/types.rb,
lib/claude_code/client.rb,
lib/claude_code/errors.rb,
lib/claude_code/version.rb

Defined Under Namespace

Modules: JSONLHelpers Classes: AssistantMessage, BaseMessage, CLIConnectionError, CLIJSONDecodeError, CLINotFoundError, ClaudeCodeOptions, ClaudeSDKError, Client, McpHttpServerConfig, McpSSEServerConfig, McpStdioServerConfig, ProcessError, ResultMessage, SubprocessCLITransport, SystemMessage, TextBlock, ToolResultBlock, ToolUseBlock, UserMessage

Constant Summary collapse

PERMISSION_MODES =

Permission modes

%w[default acceptEdits bypassPermissions].freeze
VERSION = 
"0.0.18"

Class Method Summary collapse

Class Method Details

.add_mcp_server(name, config) ⇒ Object

Convenience method for adding MCP servers Accepts:

  • String URLs (auto-creates McpHttpServerConfig)
  • String commands (auto-creates McpStdioServerConfig)
  • Hash configurations
  • Pre-built config objects


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
 
# File 'lib/claude_code.rb', line 70

def self.add_mcp_server(name, config)
  server_config = case config
  when String
    if config.start_with?('http://', 'https://')
      # HTTP/HTTPS URL
      McpHttpServerConfig.new(url: config)
    else
      # Stdio command
      parts = config.split(' ')
      McpStdioServerConfig.new(
        command: parts[0],
        args: parts[1..-1] || []
      )
    end
  when Hash
    # Convert hash to appropriate config object
    if config[:url] || config['url']
      # HTTP/HTTPS server
      url = config[:url] || config['url']
      headers = config[:headers] || config['headers'] || {}
      McpHttpServerConfig.new(url: url, headers: headers)
    elsif config[:command] || config['command']
      # Stdio server
      command = config[:command] || config['command']
      args = config[:args] || config['args'] || []
      env = config[:env] || config['env'] || {}
      McpStdioServerConfig.new(command: command, args: args, env: env)
    else
      raise ArgumentError, "Invalid MCP server configuration: missing required fields"
    end
  when McpHttpServerConfig, McpSSEServerConfig, McpStdioServerConfig
    # Already a config object
    config
  else
    raise ArgumentError, "Invalid MCP server configuration type: #{config.class}"
  end
  
  { name => server_config }
end

.api_key_configured? ⇒ Boolean

Check if API key is configured

Returns:

  • (Boolean) 


14
15
16
 
# File 'lib/claude_code.rb', line 14

def self.api_key_configured?
  !ENV['ANTHROPIC_API_KEY'].nil? && !ENV['ANTHROPIC_API_KEY'].strip.empty?
end

.auto_format_message(message) ⇒ Object

Auto-format message for pretty printing



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/claude_code.rb', line 291

def self.auto_format_message(message)
  case message
  when SystemMessage
    puts "🔧 System: #{message.subtype}" if message.subtype != "init"
  when AssistantMessage
    message.content.each do |block|
      case block
      when TextBlock
        puts "💬 #{block.text}"
      when ToolUseBlock
        puts "🔧 #{block.name}"
      when ToolResultBlock
        puts "📤 #{block.content}"
      end
    end
  when ResultMessage
    puts "✅ Cost: $#{format('%.6f', message.total_cost_usd || 0)}"
  end
  $stdout.flush
end

.continue_conversation(prompt = nil, options: nil, cli_path: nil, mcp_servers: {}) ⇒ Object

Continue the most recent conversation



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/claude_code.rb', line 137

def self.continue_conversation(prompt = nil, options: nil, cli_path: nil, mcp_servers: {})
  options ||= ClaudeCodeOptions.new
  
  # Set continue_conversation to true
  continue_options = ClaudeCodeOptions.new(
    allowed_tools: options.allowed_tools,
    max_thinking_tokens: options.max_thinking_tokens,
    system_prompt: options.system_prompt,
    append_system_prompt: options.append_system_prompt,
    mcp_tools: options.mcp_tools,
    mcp_servers: options.mcp_servers,
    permission_mode: options.permission_mode,
    continue_conversation: true,
    resume: options.resume,
    max_turns: options.max_turns,
    disallowed_tools: options.disallowed_tools,
    model: options.model,
    permission_prompt_tool_name: options.permission_prompt_tool_name,
    cwd: options.cwd
  )
  
  query(
    prompt: prompt || "",
    options: continue_options,
    cli_path: cli_path,
    mcp_servers: mcp_servers
  )
end

.parse_cli_message(data) ⇒ Object

Helper method to parse CLI messages for streaming JSON input



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/claude_code.rb', line 231

def self.parse_cli_message(data)
  case data['type']
  when 'user'
    UserMessage.new(data.dig('message', 'content'))
  when 'assistant'
    content_blocks = parse_content_blocks(data.dig('message', 'content') || [])
    AssistantMessage.new(content_blocks)
  when 'system'
    SystemMessage.new(subtype: data['subtype'], data: data)
  when 'result'
    ResultMessage.new(
      subtype: data['subtype'],
      duration_ms: data['duration_ms'],
      duration_api_ms: data['duration_api_ms'],
      is_error: data['is_error'],
      num_turns: data['num_turns'],
      session_id: data['session_id'],
      total_cost_usd: data['total_cost_usd'],
      usage: data['usage'],
      result: data['result']
    )
  end
end

.parse_content_blocks(blocks) ⇒ Object

Helper method to parse content blocks



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/claude_code.rb', line 256

def self.parse_content_blocks(blocks)
  blocks.map do |block|
    case block['type']
    when 'text'
      TextBlock.new(block['text'])
    when 'tool_use'
      ToolUseBlock.new(id: block['id'], name: block['name'], input: block['input'])
    when 'tool_result'
      ToolResultBlock.new(
        tool_use_id: block['tool_use_id'],
        content: block['content'],
        is_error: block['is_error']
      )
    end
  end.compact
end

.query(prompt_or_args = nil, prompt: nil, options: nil, cli_path: nil, mcp_servers: {}, &block) ⇒ Object

Main query method - supports both positional and keyword arguments



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
 
# File 'lib/claude_code.rb', line 19

def self.query(prompt_or_args = nil, prompt: nil, options: nil, cli_path: nil, mcp_servers: {}, &block)
  # Handle positional argument for backward compatibility
  if prompt_or_args.is_a?(String)
    prompt = prompt_or_args
  elsif prompt_or_args.is_a?(Hash)
    # Extract from hash if all args passed as first parameter
    prompt = prompt_or_args[:prompt] || prompt
    options = prompt_or_args[:options] || options
    cli_path = prompt_or_args[:cli_path] || cli_path
    mcp_servers = prompt_or_args[:mcp_servers] || mcp_servers
  end
  options ||= ClaudeCodeOptions.new
  
  # Merge MCP servers if provided as a separate parameter
  unless mcp_servers.empty?
    options = ClaudeCodeOptions.new(
      allowed_tools: options.allowed_tools,
      max_thinking_tokens: options.max_thinking_tokens,
      system_prompt: options.system_prompt,
      append_system_prompt: options.append_system_prompt,
      mcp_tools: options.mcp_tools,
      mcp_servers: options.mcp_servers.merge(mcp_servers),
      permission_mode: options.permission_mode,
      continue_conversation: options.continue_conversation,
      resume: options.resume,
      max_turns: options.max_turns,
      disallowed_tools: options.disallowed_tools,
      model: options.model,
      permission_prompt_tool_name: options.permission_prompt_tool_name,
      cwd: options.cwd
    )
  end
  
  ENV['CLAUDE_CODE_ENTRYPOINT'] = 'sdk-ruby'
  
  client = Client.new
  result = client.process_query(prompt: prompt, options: options, cli_path: cli_path, mcp_servers: mcp_servers)
  
  if block_given?
    result.each { |message| yield message }
  else
    result
  end
end

.quick_mcp_query(prompt, server_name:, server_url:, tools:, **options) ⇒ Object

Ultra-convenient method for quick MCP queries



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/claude_code.rb', line 111

def self.quick_mcp_query(prompt, server_name:, server_url:, tools:, **options)
  cli_path = options.delete(:cli_path)
  
  mcp_servers = add_mcp_server(server_name, server_url)
  
  # Ensure tools are in the correct format
  allowed_tools = Array(tools).map { |tool|
    tool.start_with?("mcp__") ? tool : "mcp__#{server_name}__#{tool}"
  }
  
  opts = ClaudeCodeOptions.new(
    allowed_tools: allowed_tools,
    max_turns: options[:max_turns] || 1,
    system_prompt: options[:system_prompt] || "You are helpful. Use the available MCP tools to answer questions.",
    **options.slice(:model, :permission_mode, :cwd)
  )
  
  query(
    prompt: prompt,
    options: opts,
    cli_path: cli_path,
    mcp_servers: mcp_servers
  )
end

.resume_conversation(session_id, prompt = nil, options: nil, cli_path: nil, mcp_servers: {}) ⇒ Object

Resume a specific conversation by session ID



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/claude_code.rb', line 167

def self.resume_conversation(session_id, prompt = nil, options: nil, cli_path: nil, mcp_servers: {})
  options ||= ClaudeCodeOptions.new
  
  # Set resume with the session ID
  resume_options = ClaudeCodeOptions.new(
    allowed_tools: options.allowed_tools,
    max_thinking_tokens: options.max_thinking_tokens,
    system_prompt: options.system_prompt,
    append_system_prompt: options.append_system_prompt,
    mcp_tools: options.mcp_tools,
    mcp_servers: options.mcp_servers,
    permission_mode: options.permission_mode,
    continue_conversation: options.continue_conversation,
    resume_conversation_id: session_id,
    max_turns: options.max_turns,
    disallowed_tools: options.disallowed_tools,
    model: options.model,
    permission_prompt_tool_name: options.permission_prompt_tool_name,
    cwd: options.cwd
  )
  
  query(
    prompt: prompt || "",
    options: resume_options,
    cli_path: cli_path,
    mcp_servers: mcp_servers
  )
end

.stream_json_query(messages, options: nil, cli_path: nil, mcp_servers: {}, &block) ⇒ Object

Query with streaming JSON input (multiple turns via JSONL)



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/claude_code.rb', line 197

def self.stream_json_query(messages, options: nil, cli_path: nil, mcp_servers: {}, &block)
  options ||= ClaudeCodeOptions.new
  
  # Set input_format to stream-json
  stream_options = ClaudeCodeOptions.new(
    allowed_tools: options.allowed_tools,
    max_thinking_tokens: options.max_thinking_tokens,
    system_prompt: options.system_prompt,
    append_system_prompt: options.append_system_prompt,
    mcp_tools: options.mcp_tools,
    mcp_servers: options.mcp_servers,
    permission_mode: options.permission_mode,
    continue_conversation: options.continue_conversation,
    resume_conversation_id: options.resume_conversation_id,
    max_turns: options.max_turns,
    disallowed_tools: options.disallowed_tools,
    model: options.model,
    permission_prompt_tool_name: options.permission_prompt_tool_name,
    cwd: options.cwd,
    input_format: 'stream-json'
  )
  
  # Use the client to process the query
  client = Client.new
  enumerator = client.process_query(messages: messages, options: stream_options, cli_path: cli_path, mcp_servers: mcp_servers)
  
  if block_given?
    enumerator.each { |message| yield message }
  else
    enumerator
  end
end

.stream_query(prompt:, options: nil, cli_path: nil, mcp_servers: {}, &block) ⇒ Object

Streaming helper that prints messages as they arrive



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/claude_code.rb', line 274

def self.stream_query(prompt:, options: nil, cli_path: nil, mcp_servers: {}, &block)
  query(
    prompt: prompt,
    options: options,
    cli_path: cli_path,
    mcp_servers: mcp_servers
  ).each_with_index do |message, index|
    if block_given?
      yield message, index
    else
      # Use auto_format_message for consistent formatting
      auto_format_message(message)
    end
  end
end