claude-code-sdk-ruby 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17f03088a7ce2f00f3f3fedc4c1b6fdece21831a6d3ccbc90bcefab2faaf5a75
-  data.tar.gz: 5d2dc1e635eef3e3fcd94f0587961df9e87eb0f26172c15f568742c5ee859a4b
+  metadata.gz: 271d1f22697c1e35a2b9bbea19c7258ed714009bb9237bc2a5482af44ec6a32f
+  data.tar.gz: 692fe7861052964d3511166afc95551552ffed534e723f764d5fd5301b7a0e3c
 SHA512:
-  metadata.gz: c44a60dca629d3be19f8a27acf421962f7aeb9cf5a0b54492dee5c86350252648c4b927e8e3b43b63135159c8581c1f895d31b418053958eb092a72059dc5441
-  data.tar.gz: 749804df124c0b048b1664771c05b97cde812fb732d3ffb0a44c6334a872f891c387dfa09065f91cb9733d7d10a238340e00efca1d790f02f7005ad41bf210c3
+  metadata.gz: 7033b78c154965204db8cba25b144c920bf62cc7481e39addb823837bdd118f1c5a35a383d58eccc49c3b29a8021d7576dee5ff4765b88f153a83f700eb22ed4
+  data.tar.gz: 1df5a522cf96cb11e4ad0da37fd9c2a83988928e1d5eb4c04f2643c3f26378d3dd5fd99687fd950fce69bf6dd5f31bee14a5086778a44389f65dbf6e6f16f1ab

data/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.6] - 2025-07-30
+
+### Added
+- Support for `--settings` flag to load additional settings from a JSON file
+  - Added `settings` parameter to `ClaudeCodeOptions`
+  - CLI command now includes `--settings` when settings file path is provided
+  - Added example demonstrating how to use settings files
+  - Updated documentation with Claude Code settings format
+
 ## [0.1.4] - 2025-07-18
 
 ### Fixed

data/README.md

@@ -107,6 +107,48 @@ messages.each do |message|
 end
 ```
 
+### Using Settings Files
+
+You can load additional settings from a JSON file:
+
+```ruby
+require 'claude_sdk'
+
+# Create options with a settings file path
+options = ClaudeSDK::ClaudeCodeOptions.new(
+  settings: '/path/to/claude-settings.json',
+  model: 'sonnet'  # Other options can still be specified
+)
+
+ClaudeSDK.query("Hello", options: options) do |message|
+  puts message
+end
+```
+
+The settings file should be a valid JSON file containing Claude Code configuration options:
+
+```json
+{
+  "permissions": {
+    "allow": [
+      "Bash(npm run lint)",
+      "Bash(npm run test:*)",
+      "Read(~/.zshrc)"
+    ],
+    "deny": [
+      "Bash(curl:*)"
+    ]
+  },
+  "env": {
+    "CLAUDE_CODE_ENABLE_TELEMETRY": "1",
+    "OTEL_METRICS_EXPORTER": "otlp"
+  },
+  "model": "claude-3-5-sonnet-20241022",
+  "cleanupPeriodDays": 20,
+  "includeCoAuthoredBy": true
+}
+```
+
 ### Advanced: Using the Internal Client Directly
 
 ```ruby
@@ -166,6 +208,7 @@ The `ClaudeCodeOptions` class supports all Claude Code CLI options:
 - `continue_conversation` - Whether to continue from previous conversation
 - `resume` - Resume from a specific conversation ID
 - `mcp_servers` - MCP server configuration
+- `settings` - Path to a settings JSON file to load additional settings from
 
 ## Error Handling
 

data/examples/with_settings.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "claude_sdk"
+require "json"
+require "tmpdir"
+
+# Example demonstrating how to use the --settings flag
+# This creates a temporary settings file and uses it with the SDK
+
+Dir.mktmpdir do |tmpdir|
+  # Create a sample settings file
+  settings_path = File.join(tmpdir, "claude-settings.json")
+
+  settings_content = {
+    "permissions" => {
+      "allow" => [
+        "Bash(npm run lint)",
+        "Bash(npm run test:*)",
+        "Read(~/.zshrc)",
+      ],
+      "deny" => [
+        "Bash(curl:*)",
+      ],
+    },
+    "env" => {
+      "CLAUDE_CODE_ENABLE_TELEMETRY" => "1",
+      "OTEL_METRICS_EXPORTER" => "otlp",
+    },
+    "model" => "claude-3-5-sonnet-20241022",
+    "cleanupPeriodDays" => 20,
+    "includeCoAuthoredBy" => true,
+  }
+
+  File.write(settings_path, JSON.pretty_generate(settings_content))
+
+  puts "Created settings file at: #{settings_path}"
+  puts "Settings content:"
+  puts JSON.pretty_generate(settings_content)
+  puts "\n---\n\n"
+
+  # Create options with the settings file path
+  options = ClaudeSDK::ClaudeCodeOptions.new(
+    settings: settings_path,
+    model: "sonnet",
+  )
+
+  # Query Claude with the settings
+  puts "Querying Claude with settings file..."
+
+  ClaudeSDK.query("What is 2 + 2?", options: options) do |message|
+    if message.is_a?(Hash)
+      type = message["type"]
+
+      case type
+      when "text"
+        print(message["text"])
+      when "result"
+        puts "\n\nResult: #{message["result"]}" if message["result"]
+      end
+    end
+  end
+end

data/lib/claude_sdk/internal/transport/subprocess_cli.rb

@@ -342,6 +342,8 @@ module ClaudeSDK
 
         cmd.push("--session-id", @options.session_id) if @options.session_id
 
+        cmd.push("--settings", @options.settings.to_s) if @options.settings
+
         if @options.mcp_servers && !@options.mcp_servers.empty?
           mcp_config = { "mcpServers" => serialize_mcp_servers }
           cmd.push("--mcp-config", JSON.generate(mcp_config))

data/lib/claude_sdk/types.rb

@@ -322,6 +322,7 @@ module ClaudeSDK
   # @!attribute model [String, nil] model to use
   # @!attribute permission_prompt_tool_name [String, nil] permission prompt tool
   # @!attribute cwd [String, Pathname, nil] working directory
+  # @!attribute settings [String, Pathname, nil] path to settings JSON file
   class ClaudeCodeOptions
     attr_accessor :allowed_tools,
       :max_thinking_tokens,
@@ -337,7 +338,8 @@ module ClaudeSDK
       :model,
       :permission_prompt_tool_name,
       :cwd,
-      :session_id
+      :session_id,
+      :settings
 
     # Initialize with default values
     #
@@ -356,6 +358,7 @@ module ClaudeSDK
     # @param permission_prompt_tool_name [String, nil] permission tool
     # @param cwd [String, Pathname, nil] working directory
     # @param session_id [String, nil] session ID (must be a valid UUID)
+    # @param settings [String, Pathname, nil] path to settings JSON file
     def initialize(allowed_tools: [],
       max_thinking_tokens: 8000,
       system_prompt: nil,
@@ -370,7 +373,8 @@ module ClaudeSDK
       model: nil,
       permission_prompt_tool_name: nil,
       cwd: nil,
-      session_id: nil)
+      session_id: nil,
+      settings: nil)
       @allowed_tools = allowed_tools
       @max_thinking_tokens = max_thinking_tokens
       @system_prompt = system_prompt
@@ -386,6 +390,7 @@ module ClaudeSDK
       @permission_prompt_tool_name = permission_prompt_tool_name
       @cwd = cwd
       @session_id = session_id
+      @settings = settings
 
       validate_permission_mode! if permission_mode
     end
@@ -410,6 +415,7 @@ module ClaudeSDK
       hash[:permission_prompt_tool_name] = permission_prompt_tool_name if permission_prompt_tool_name
       hash[:cwd] = cwd.to_s if cwd
       hash[:session_id] = session_id if session_id
+      hash[:settings] = settings.to_s if settings
       hash
     end
 

data/lib/claude_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ClaudeSDK
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: claude-code-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Paulo Arruda
@@ -60,6 +60,7 @@ files:
 - examples/error_handling.rb
 - examples/mcp_servers.rb
 - examples/with_options.rb
+- examples/with_settings.rb
 - lib/claude_sdk.rb
 - lib/claude_sdk/errors.rb
 - lib/claude_sdk/internal/client.rb