Class: ClaudeAgentSDK::ClaudeAgentOptions

Inherits:
Type
  • Object
show all
Defined in:
lib/claude_agent_sdk/types.rb

Overview

Claude Agent Options for configuring queries

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Type

#[], #[]=, from_hash, #to_h, wrap

Constructor Details

#initialize(attributes = {}) ⇒ ClaudeAgentOptions

Returns a new instance of ClaudeAgentOptions.



1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
 
# File 'lib/claude_agent_sdk/types.rb', line 1564

def initialize(attributes = {})
  self.fork_session = false
  self.continue_conversation = false
  self.include_partial_messages = false
  self.enable_file_checkpointing = false
  self.include_hook_events = false
  self.strict_mcp_config = false

  super(merge_with_defaults(attributes || {}))

  # Non-nil defaults for options that need them.
  self.env                 ||= {}
  self.extra_args          ||= {}
  self.mcp_servers         ||= {}
  self.add_dirs            ||= []
  self.observers           ||= []
  self.allowed_tools       ||= []
  self.disallowed_tools    ||= []
  self.session_store_flush ||= 'batched'
  # 0 is a valid (immediate) timeout, so only fill in the default for nil.
  self.load_timeout_ms = 60_000 if load_timeout_ms.nil?
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ClaudeAgentSDK::Type

Instance Attribute Details

#add_dirs ⇒ Object

Returns the value of attribute add_dirs.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def add_dirs
  @add_dirs
end

#agents ⇒ Object

Returns the value of attribute agents.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def agents
  @agents
end

#allowed_tools ⇒ Object

Returns the value of attribute allowed_tools.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def allowed_tools
  @allowed_tools
end

#bare ⇒ Object

Returns the value of attribute bare.



1560
1561
1562
 
# File 'lib/claude_agent_sdk/types.rb', line 1560

def bare
  @bare
end

#betas ⇒ Object

Returns the value of attribute betas.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def betas
  @betas
end

#can_use_tool ⇒ Object

Returns the value of attribute can_use_tool.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def can_use_tool
  @can_use_tool
end

#cli_path ⇒ Object

Returns the value of attribute cli_path.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def cli_path
  @cli_path
end

#continue_conversation ⇒ Object

Returns the value of attribute continue_conversation.



1560
1561
1562
 
# File 'lib/claude_agent_sdk/types.rb', line 1560

def continue_conversation
  @continue_conversation
end

#cwd ⇒ Object

Returns the value of attribute cwd.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def cwd
  @cwd
end

#debug_stderr ⇒ Object

Returns the value of attribute debug_stderr.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def debug_stderr
  @debug_stderr
end

#disallowed_tools ⇒ Object

Returns the value of attribute disallowed_tools.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def disallowed_tools
  @disallowed_tools
end

#effort ⇒ Object

Returns the value of attribute effort.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def effort
  @effort
end

#enable_file_checkpointing ⇒ Object

Returns the value of attribute enable_file_checkpointing.



1560
1561
1562
 
# File 'lib/claude_agent_sdk/types.rb', line 1560

def enable_file_checkpointing
  @enable_file_checkpointing
end

#env ⇒ Object

Returns the value of attribute env.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def env
  @env
end

#extra_args ⇒ Object

Returns the value of attribute extra_args.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def extra_args
  @extra_args
end

#fallback_model ⇒ Object

Returns the value of attribute fallback_model.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def fallback_model
  @fallback_model
end

#fork_session ⇒ Object

Returns the value of attribute fork_session.



1560
1561
1562
 
# File 'lib/claude_agent_sdk/types.rb', line 1560

def fork_session
  @fork_session
end

#hooks ⇒ Object

Returns the value of attribute hooks.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def hooks
  @hooks
end

#include_hook_events ⇒ Object

Returns the value of attribute include_hook_events.



1560
1561
1562
 
# File 'lib/claude_agent_sdk/types.rb', line 1560

def include_hook_events
  @include_hook_events
end

#include_partial_messages ⇒ Object

Returns the value of attribute include_partial_messages.



1560
1561
1562
 
# File 'lib/claude_agent_sdk/types.rb', line 1560

def include_partial_messages
  @include_partial_messages
end

#load_timeout_ms ⇒ Object

Returns the value of attribute load_timeout_ms.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def load_timeout_ms
  @load_timeout_ms
end

#max_budget_usd ⇒ Object

Returns the value of attribute max_budget_usd.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def max_budget_usd
  @max_budget_usd
end

#max_buffer_size ⇒ Object

Returns the value of attribute max_buffer_size.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def max_buffer_size
  @max_buffer_size
end

#max_thinking_tokens ⇒ Object

Returns the value of attribute max_thinking_tokens.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def max_thinking_tokens
  @max_thinking_tokens
end

#max_turns ⇒ Object

Returns the value of attribute max_turns.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def max_turns
  @max_turns
end

#mcp_servers ⇒ Object

Returns the value of attribute mcp_servers.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def mcp_servers
  @mcp_servers
end

#model ⇒ Object

Returns the value of attribute model.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def model
  @model
end

#observers ⇒ Object

Returns the value of attribute observers.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def observers
  @observers
end

#output_format ⇒ Object

Returns the value of attribute output_format.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def output_format
  @output_format
end

#permission_mode ⇒ Object

Returns the value of attribute permission_mode.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def permission_mode
  @permission_mode
end

#permission_prompt_tool_name ⇒ Object

Returns the value of attribute permission_prompt_tool_name.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def permission_prompt_tool_name
  @permission_prompt_tool_name
end

#plugins ⇒ Object

Returns the value of attribute plugins.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def plugins
  @plugins
end

#resume ⇒ Object

Returns the value of attribute resume.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def resume
  @resume
end

#resume_session_at ⇒ Object

Returns the value of attribute resume_session_at.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def resume_session_at
  @resume_session_at
end

#sandbox ⇒ Object

Returns the value of attribute sandbox.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def sandbox
  @sandbox
end

#session_id ⇒ Object

Returns the value of attribute session_id.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def session_id
  @session_id
end

#session_store ⇒ Object

Returns the value of attribute session_store.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def session_store
  @session_store
end

#session_store_flush ⇒ Object

Returns the value of attribute session_store_flush.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def session_store_flush
  @session_store_flush
end

#setting_sources ⇒ Object

Returns the value of attribute setting_sources.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def setting_sources
  @setting_sources
end

#settings ⇒ Object

Returns the value of attribute settings.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def settings
  @settings
end

#skills ⇒ Object

Returns the value of attribute skills.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def skills
  @skills
end

#stderr ⇒ Object

Returns the value of attribute stderr.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def stderr
  @stderr
end

#strict_mcp_config ⇒ Object

Returns the value of attribute strict_mcp_config.



1560
1561
1562
 
# File 'lib/claude_agent_sdk/types.rb', line 1560

def strict_mcp_config
  @strict_mcp_config
end

#system_prompt ⇒ Object

Returns the value of attribute system_prompt.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def system_prompt
  @system_prompt
end

#task_budget ⇒ Object

Returns the value of attribute task_budget.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def task_budget
  @task_budget
end

#thinking ⇒ Object

Returns the value of attribute thinking.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def thinking
  @thinking
end

#tools ⇒ Object

Returns the value of attribute tools.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def tools
  @tools
end

#user ⇒ Object

Returns the value of attribute user.



1549
1550
1551
 
# File 'lib/claude_agent_sdk/types.rb', line 1549

def user
  @user
end

Instance Method Details

#bare? ⇒ Boolean

Returns:

  • (Boolean) 


1593
1594
1595
 
# File 'lib/claude_agent_sdk/types.rb', line 1593

def bare?
  !!bare
end

#continue_conversation? ⇒ Boolean

Returns:

  • (Boolean) 


1625
1626
1627
 
# File 'lib/claude_agent_sdk/types.rb', line 1625

def continue_conversation?
  !!continue_conversation
end

#dup_with(**changes) ⇒ Object 



1587
1588
1589
1590
1591
 
# File 'lib/claude_agent_sdk/types.rb', line 1587

def dup_with(**changes)
  new_options = self.dup
  changes.each { |key, value| new_options[key] = value }
  new_options
end

#enable_file_checkpointing? ⇒ Boolean

Returns:

  • (Boolean) 


1609
1610
1611
 
# File 'lib/claude_agent_sdk/types.rb', line 1609

def enable_file_checkpointing?
  !!enable_file_checkpointing
end

#fork_session? ⇒ Boolean

Returns:

  • (Boolean) 


1601
1602
1603
 
# File 'lib/claude_agent_sdk/types.rb', line 1601

def fork_session?
  !!fork_session
end

#include_hook_events? ⇒ Boolean

Returns:

  • (Boolean) 


1633
1634
1635
 
# File 'lib/claude_agent_sdk/types.rb', line 1633

def include_hook_events?
  !!include_hook_events
end

#include_partial_messages? ⇒ Boolean

Returns:

  • (Boolean) 


1617
1618
1619
 
# File 'lib/claude_agent_sdk/types.rb', line 1617

def include_partial_messages?
  !!include_partial_messages
end

#strict_mcp_config? ⇒ Boolean

Returns:

  • (Boolean) 


1641
1642
1643
 
# File 'lib/claude_agent_sdk/types.rb', line 1641

def strict_mcp_config?
  !!strict_mcp_config
end