claude-agent-sdk 1.1.0 → 1.2.1

data/lib/generators/claude_agent_sdk/install/templates/claude_agent_sdk.rb.tt

@@ -22,6 +22,12 @@ ClaudeAgentSDK.configure do |config|
     # whatever the process cwd. To run a binary from somewhere else instead:
     # cli_path: '/usr/local/bin/claude',
 
+    # Multi-user apps: turn off the CLI's auto-memory — kept per project
+    # directory, read by every session and written by claude_code-preset
+    # sessions, so one user's "remember ..." reaches all others (the value
+    # must stay '1'; '0' forces it on). See docs/rails.md ("Per-user isolation").
+    # env: { 'CLAUDE_CODE_DISABLE_AUTO_MEMORY' => '1' },
+
     # OpenTelemetry tracing (Langfuse, Honeycomb, ...). A factory lambda gives
     # every query/session its own observer — safe under Puma and job threads.
     # observers: [-> { ClaudeAgentSDK::Instrumentation::OTelObserver.new }],

data/sig/claude_agent_sdk/types/hooks.rbs

@@ -47,8 +47,9 @@ module ClaudeAgentSDK
                             | CwdChangedHookSpecificOutput
                             | FileChangedHookSpecificOutput
 
-  # What a hook callback returns: a Hash (snake_case or camelCase keys), a
-  # typed output, or nil (treated as {}).
+  # What a hook callback returns: a Hash (Symbol or String keys, snake_case
+  # or camelCase, also inside hook_specific_output), a typed output, or nil
+  # (treated as {}).
   type hook_output = Hash[Symbol | String, untyped] | SyncHookJSONOutput | AsyncHookJSONOutput | nil
 
   # A hook callback (HookMatcher#hooks entries). tool_use_id is nil for
@@ -520,7 +521,9 @@ module ClaudeAgentSDK
 
     attr_accessor reason: String?
 
-    # A typed output, or the equivalent Hash (camelCase wire keys, sent as-is).
+    # A typed output, or the equivalent Hash (snake_case or camelCase keys).
+    # #to_h returns a Hash as written; the SDK puts its keys in wire spelling
+    # when it sends the output.
     attr_accessor hook_specific_output: (hook_specific_output | Hash[Symbol | String, untyped])?
 
     def to_h: () -> Hash[Symbol, untyped]

data/sig/claude_agent_sdk/types/option_values.rbs

@@ -7,6 +7,16 @@ module ClaudeAgentSDK
   # the Hash form (String or camelCase keys, e.g. `klass.new(value.to_h)`)
   # is accepted too. An unknown key raises ArgumentError. Discriminators
   # (`type`) are fixed by the class and read-only.
+  #
+  # The keyword overload documents the accepted keys and their types; no
+  # type checker enforces it. `klass.new(typo: 1)` is also a Symbol-keyed
+  # Hash, which the second overload accepts whatever its keys and values, so
+  # Steep reports neither a misspelled keyword nor a wrong value type, and
+  # the runtime checker behind `rake rbs:test` never reports a constructor
+  # mismatch (it only checks the attribute setters the constructor calls).
+  # The enforcement is the ArgumentError the constructor raises at runtime
+  # for an unknown key. This holds for every constructor in sig/ that has
+  # both overloads.
 
   # Adaptive thinking: the model decides when and how much to think.
   class ThinkingConfigAdaptive < Type
@@ -81,15 +91,15 @@ module ClaudeAgentSDK
 
   # A local plugin directory (ClaudeAgentOptions#plugins entries).
   class SdkPluginConfig < Type
-    def initialize: (?path: String?) -> void
+    def initialize: (?path: (String | Pathname)?) -> void
                   | (Hash[Symbol | String, untyped]? attributes) -> void
 
-    attr_accessor path: String?
+    attr_accessor path: (String | Pathname)?
 
     # "local".
     attr_reader type: String
 
-    def to_h: () -> { type: String, path: String? }
+    def to_h: () -> { type: String, path: (String | Pathname)? }
   end
 
   class SandboxNetworkConfig < Type
@@ -138,6 +148,13 @@ module ClaudeAgentSDK
 
   # Sandbox settings for isolated command execution
   # (ClaudeAgentOptions#sandbox).
+  #
+  # network / filesystem take the typed config or a Hash. A Hash may spell
+  # the fields of the typed class in snake_case or in the CLI's camelCase,
+  # with Symbol or String keys; other keys are sent as written. A snake_case
+  # key is sent under the CLI's name only when its value has the shape the
+  # CLI accepts for it; otherwise it is sent as written, which the CLI
+  # ignores.
   class SandboxSettings < Type
     def initialize: (?enabled: bool?, ?fail_if_unavailable: bool?, ?auto_allow_bash_if_sandboxed: bool?, ?excluded_commands: Array[String]?, ?allow_unsandboxed_commands: bool?, ?network: (SandboxNetworkConfig | Hash[Symbol | String, untyped])?, ?filesystem: (SandboxFilesystemConfig | Hash[Symbol | String, untyped])?, ?ignore_violations: Hash[Symbol | String, Array[String]]?, ?enable_weaker_nested_sandbox: bool?, ?enable_weaker_network_isolation: bool?, ?ripgrep: Hash[Symbol | String, untyped]?) -> void
                   | (Hash[Symbol | String, untyped]? attributes) -> void
@@ -181,15 +198,15 @@ module ClaudeAgentSDK
 
   # A system prompt loaded from a file.
   class SystemPromptFile < Type
-    def initialize: (?path: String?) -> void
+    def initialize: (?path: (String | Pathname)?) -> void
                   | (Hash[Symbol | String, untyped]? attributes) -> void
 
-    attr_accessor path: String?
+    attr_accessor path: (String | Pathname)?
 
     # "file".
     attr_reader type: String
 
-    def to_h: () -> { type: String, path: String? }
+    def to_h: () -> { type: String, path: (String | Pathname)? }
   end
 
   # The Claude Code preset system prompt, optionally extended.

data/sig/claude_agent_sdk/types/options.rbs

@@ -48,7 +48,7 @@ module ClaudeAgentSDK
                       ?permission_prompt_tool_name: String?,
                       ?cwd: (String | Pathname)?,
                       ?cli_path: (String | Pathname)?,
-                      ?settings: (String | Hash[Symbol | String, untyped])?,
+                      ?settings: (String | Pathname | Hash[Symbol | String, untyped])?,
                       ?add_dirs: Array[String | Pathname]?,
                       ?env: Hash[String | Symbol, String?]?,
                       ?extra_args: Hash[String | Symbol, untyped]?,
@@ -68,7 +68,7 @@ module ClaudeAgentSDK
                       ?plugins: Array[SdkPluginConfig | Hash[Symbol | String, untyped]]?,
                       ?debug_stderr: (_Puts | String)?,
                       ?betas: Array[String]?,
-                      ?tools: (Array[String] | ToolsPreset | Hash[Symbol | String, untyped])?,
+                      ?tools: (Array[String] | ToolsPreset | Hash[Symbol | String, untyped] | String)?,
                       ?sandbox: (SandboxSettings | Hash[Symbol | String, untyped] | bool)?,
                       ?thinking: thinking_config?,
                       ?effort: (String | Symbol | Integer)?,
@@ -133,8 +133,9 @@ module ClaudeAgentSDK
 
     attr_accessor cli_path: (String | Pathname)?
 
-    # A settings JSON String, a path to a settings file, or a Hash.
-    attr_accessor settings: (String | Hash[Symbol | String, untyped])?
+    # A settings JSON String, a path to a settings file (a String or a
+    # Pathname), or a Hash.
+    attr_accessor settings: (String | Pathname | Hash[Symbol | String, untyped])?
 
     attr_accessor add_dirs: Array[String | Pathname]?
 
@@ -185,10 +186,13 @@ module ClaudeAgentSDK
     # Entries of SDK_BETAS.
     attr_accessor betas: Array[String]?
 
-    # The base tool set: tool names, or a preset.
-    attr_accessor tools: (Array[String] | ToolsPreset | Hash[Symbol | String, untyped])?
+    # The base tool set: tool names (an Array, or the CLI's comma-separated
+    # String such as "Read,Grep"), or a preset.
+    attr_accessor tools: (Array[String] | ToolsPreset | Hash[Symbol | String, untyped] | String)?
 
-    # true / false are forwarded as-is (a bare toggle).
+    # true / false are forwarded as-is (a bare toggle). A Hash may spell the
+    # fields of SandboxSettings, and of its network / filesystem, in
+    # snake_case or in the CLI's camelCase (see SandboxSettings).
     attr_accessor sandbox: (SandboxSettings | Hash[Symbol | String, untyped] | bool)?
 
     attr_accessor thinking: thinking_config?

data/sig/claude_agent_sdk/types/permissions.rbs

@@ -41,7 +41,8 @@ module ClaudeAgentSDK
 
     attr_accessor directories: Array[String]?
 
-    # One of PERMISSION_UPDATE_DESTINATIONS.
+    # One of PERMISSION_UPDATE_DESTINATIONS. When nil, #to_h sends "session"
+    # (unless type is nil too).
     attr_accessor destination: String?
 
     attr_reader rules: Array[PermissionRuleValue]?
@@ -49,7 +50,8 @@ module ClaudeAgentSDK
     # Hash entries (camelCase or snake_case keys) become PermissionRuleValue.
     def rules=: (Array[PermissionRuleValue | Hash[Symbol | String, untyped]]? value) -> Array[PermissionRuleValue | Hash[Symbol | String, untyped]]?
 
-    # The wire form (camelCase keys).
+    # The wire form (camelCase keys). A rule without content has no
+    # ruleContent key.
     def to_h: () -> Hash[Symbol, untyped]
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: claude-agent-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - ya-luotao
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-30 00:00:00.000000000 Z
+date: 2026-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -54,14 +54,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -118,6 +118,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - CHANGELOG.md
 - LICENSE
 - README.md
@@ -129,6 +130,7 @@ files:
 - docs/hooks-and-permissions.md
 - docs/mcp-servers.md
 - docs/observability.md
+- docs/options.md
 - docs/rails.md
 - docs/sessions.md
 - docs/subagents.md
@@ -146,10 +148,13 @@ files:
 - lib/claude_agent_sdk/instrumentation/otel.rb
 - lib/claude_agent_sdk/message_parser.rb
 - lib/claude_agent_sdk/observer.rb
+- lib/claude_agent_sdk/option_forms.rb
 - lib/claude_agent_sdk/option_warnings.rb
 - lib/claude_agent_sdk/query.rb
+- lib/claude_agent_sdk/query/run_lifecycle.rb
 - lib/claude_agent_sdk/railtie.rb
 - lib/claude_agent_sdk/sdk_mcp_server.rb
+- lib/claude_agent_sdk/session_assembly.rb
 - lib/claude_agent_sdk/session_mutations.rb
 - lib/claude_agent_sdk/session_resume.rb
 - lib/claude_agent_sdk/session_store.rb