codex-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f275364a09a5cc846fa53ffd2b0a670a304fc16f69bb9e0b57f1e0e93fe1238
+  data.tar.gz: 060edb785c62c1d28ac68cfd572d0be71e549a55390d6de8b950876e73ff2b8b
+SHA512:
+  metadata.gz: 788c559e4e8a03ae43e3f774c9bb58f3553d3dbf10c8140d95977cf6918cdb827f70074fe6cb67af0428981467337d0260974c7cd22677cc0ad044c55abca34a
+  data.tar.gz: fdf5fba234c30116e18bad26cc4004a3c3cafdb9425635f2c42c4baf9062b94bce82cc5b33e45d191c7198fdf8bd1fcedb3c70ee05bff5bf4633f473028cf1b9

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-10-20
+
+### Added
+- Initial release of **unofficial** Ruby SDK for Codex CLI
+- ⚠️ This is a community-maintained SDK, not officially supported
+- Core `Codex` class for creating and resuming threads
+- `Thread` class with `run()` and `run_streamed()` methods
+- `ProcessManager` for spawning and managing Codex CLI process
+- Configuration classes: `CodexOptions`, `ThreadOptions`, `TurnOptions`
+- Event and item type constants
+- Support for structured output with JSON schemas
+- Sandbox mode support (read-only, workspace-write, danger-full-access)
+- Multi-turn conversation support
+- Thread persistence and resumption
+- Platform-specific binary detection (macOS, Linux, Windows)
+- Comprehensive test suite with RSpec
+- Full documentation and examples
+
+### Features
+- Zero runtime dependencies (uses only Ruby stdlib)
+- Streaming and buffered response modes
+- Automatic thread ID management
+- Environment variable configuration
+- Custom working directory support
+- Git repository check bypass option

data/LICENSE

@@ -0,0 +1,222 @@
+MIT License
+
+Copyright (c) 2025 Tao Luo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Note: This Ruby SDK wrapper is licensed under MIT. The Codex CLI binary that this
+SDK wraps may have its own separate license. Please refer to the Codex CLI
+documentation for information about the CLI binary's licensing.
+
+---
+
+For reference, Apache License 2.0 text:
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Support. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 OpenAI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,367 @@
+# Codex SDK for Ruby (Unofficial)
+
+**⚠️ This is an unofficial, community-maintained Ruby SDK for the Codex CLI.**
+
+This SDK wraps the Codex CLI binary to enable embedding the Codex agent in your Ruby workflows and apps. It is based on the official TypeScript SDK architecture but is not officially maintained.
+
+## Important Notes
+
+- **Unofficial SDK**: This is a community project. See [DISCLAIMER.md](DISCLAIMER.md) for details.
+- **Requires Codex CLI**: You must have the Codex CLI binary installed.
+- **Community Maintained**: Contributions welcome, but no official support.
+
+## Installation
+
+**Prerequisites**: Install the Codex CLI binary and ensure it's available in your PATH or specify its location.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'codex-sdk'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install codex-sdk
+```
+
+## Quick Start
+
+```ruby
+require 'codex_sdk'
+
+# Create a Codex instance
+codex = CodexSdk.new(api_key: ENV['CODEX_API_KEY'])
+
+# Start a new conversation thread
+thread = codex.start_thread(
+  working_directory: '/path/to/your/project'
+)
+
+# Run a turn and get the response
+result = thread.run("Diagnose the test failure in my project")
+
+puts result[:final_response]
+# => "I found the issue in your test suite..."
+
+puts "Items: #{result[:items].size}"
+puts "Usage: #{result[:usage]}"
+```
+
+## Features
+
+- **Multi-turn conversations** - Maintain context across multiple interactions
+- **Thread persistence** - Resume conversations by thread ID
+- **Streaming support** - Stream events as they arrive
+- **Structured output** - Use JSON schemas for validated responses
+- **Sandbox modes** - Control file system access levels
+- **Zero dependencies** - Uses only Ruby standard library
+
+## Usage
+
+### Basic Usage
+
+```ruby
+# Create a Codex client
+codex = CodexSdk.new
+
+# Start a thread
+thread = codex.start_thread
+
+# Send a message
+result = thread.run("What is the purpose of this codebase?")
+puts result[:final_response]
+```
+
+### Streaming Events
+
+Stream events as they arrive for real-time updates:
+
+```ruby
+thread = codex.start_thread
+
+thread.run_streamed("Fix the bug in user authentication").each do |event|
+  case event['type']
+  when 'item.started'
+    puts "Started: #{event['item']['type']}"
+  when 'item.completed'
+    item = event['item']
+    puts "Completed: #{item['type']}"
+    puts "Content: #{item['text']}" if item['text']
+  when 'turn.completed'
+    puts "Turn completed. Usage: #{event['usage']}"
+  end
+end
+```
+
+### Multi-turn Conversations
+
+```ruby
+thread = codex.start_thread
+
+# First turn
+result1 = thread.run("What files handle user authentication?")
+puts result1[:final_response]
+
+# Second turn - maintains context
+result2 = thread.run("Add two-factor authentication to those files")
+puts result2[:final_response]
+
+# Save thread ID for later
+thread_id = thread.id
+```
+
+### Resuming Threads
+
+```ruby
+# Resume a previous conversation
+thread = codex.resume_thread("thread-abc-123")
+
+# Continue the conversation
+result = thread.run("What was my last request?")
+puts result[:final_response]
+```
+
+### Structured Output with JSON Schema
+
+```ruby
+schema = {
+  type: "object",
+  properties: {
+    summary: { type: "string" },
+    priority: { type: "string", enum: ["high", "medium", "low"] },
+    files: {
+      type: "array",
+      items: { type: "string" }
+    }
+  },
+  required: ["summary", "priority"]
+}
+
+result = thread.run(
+  "Analyze the critical issues in this codebase",
+  output_schema: schema
+)
+
+# Parse the structured response
+data = JSON.parse(result[:final_response])
+puts "Summary: #{data['summary']}"
+puts "Priority: #{data['priority']}"
+puts "Files: #{data['files'].join(', ')}"
+```
+
+### Configuration Options
+
+#### Codex Options
+
+```ruby
+codex = CodexSdk.new(
+  api_key: "sk-...",                    # API key (default: ENV['CODEX_API_KEY'])
+  base_url: "https://api.custom.com",   # Custom API endpoint
+  codex_path_override: "/path/to/codex" # Custom binary path (for testing)
+)
+```
+
+#### Thread Options
+
+```ruby
+thread = codex.start_thread(
+  model: "gpt-4",                      # Model to use
+  working_directory: "/path/to/dir",   # Working directory
+  sandbox_mode: "workspace-write",     # Sandbox mode
+  skip_git_repo_check: false          # Skip git repository check
+)
+```
+
+**Sandbox Modes:**
+- `read-only` - Read-only access to files
+- `workspace-write` - Can write within workspace
+- `danger-full-access` - Full file system access
+
+### Error Handling
+
+```ruby
+begin
+  result = thread.run("Perform a complex task")
+  puts result[:final_response]
+rescue CodexSdk::ThreadError => e
+  puts "Thread error: #{e.message}"
+rescue CodexSdk::ProcessError => e
+  puts "Process error: #{e.message}"
+rescue CodexSdk::ValidationError => e
+  puts "Validation error: #{e.message}"
+end
+```
+
+## Event Types
+
+The SDK emits the following event types during streaming:
+
+- `thread.started` - Thread has been created
+- `turn.started` - A new turn has started
+- `item.started` - A new item is being generated
+- `item.updated` - An item is being updated (streaming)
+- `item.completed` - An item has been completed
+- `turn.completed` - Turn completed successfully
+- `turn.failed` - Turn failed with an error
+- `error` - An error occurred
+
+## Item Types
+
+Items represent different types of content in the conversation:
+
+- `agent_message` - Message from the agent
+- `reasoning` - Agent's reasoning/thinking
+- `command_execution` - Command execution (bash, etc.)
+- `file_change` - File modifications
+- `mcp_tool_call` - MCP tool invocations
+- `web_search` - Web search results
+- `todo_list` - Task list updates
+- `error` - Error information
+
+## Examples
+
+### Example 1: Code Review
+
+```ruby
+codex = CodexSdk.new
+thread = codex.start_thread(
+  working_directory: '/path/to/project',
+  sandbox_mode: 'read-only'
+)
+
+result = thread.run("Review the code in src/main.rb and suggest improvements")
+
+result[:items].each do |item|
+  case item['type']
+  when 'agent_message'
+    puts "Review: #{item['text']}"
+  when 'reasoning'
+    puts "Thinking: #{item['text']}"
+  end
+end
+```
+
+### Example 2: Automated Testing
+
+```ruby
+codex = CodexSdk.new
+thread = codex.start_thread(
+  working_directory: '/path/to/project',
+  sandbox_mode: 'workspace-write'
+)
+
+# Run tests
+result = thread.run("Run the test suite and fix any failures")
+
+if result[:final_response].include?("All tests passed")
+  puts "✓ Success!"
+else
+  puts "Some tests failed, running again..."
+  thread.run("Try fixing the remaining test failures")
+end
+```
+
+### Example 3: Documentation Generation
+
+```ruby
+schema = {
+  type: "object",
+  properties: {
+    summary: { type: "string" },
+    api_endpoints: {
+      type: "array",
+      items: {
+        type: "object",
+        properties: {
+          path: { type: "string" },
+          method: { type: "string" },
+          description: { type: "string" }
+        }
+      }
+    }
+  }
+}
+
+result = thread.run(
+  "Analyze the API endpoints and generate documentation",
+  output_schema: schema
+)
+
+docs = JSON.parse(result[:final_response])
+puts "API Summary: #{docs['summary']}"
+docs['api_endpoints'].each do |endpoint|
+  puts "#{endpoint['method']} #{endpoint['path']} - #{endpoint['description']}"
+end
+```
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+bundle install
+```
+
+Run tests:
+
+```bash
+bundle exec rspec
+```
+
+Run linting:
+
+```bash
+bundle exec rubocop
+```
+
+Run both tests and linting:
+
+```bash
+bundle exec rake check
+```
+
+## Platform Support
+
+The SDK supports the following platforms:
+
+- **macOS**: x86_64, ARM64 (Apple Silicon)
+- **Linux**: x86_64, ARM64
+- **Windows**: x86_64, ARM64
+
+Platform-specific binaries are automatically selected at runtime.
+
+## Requirements
+
+- Ruby >= 2.7.0
+- No external dependencies (uses Ruby stdlib only)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ya-luotao/codex-sdk-ruby.
+
+This is an unofficial SDK. For issues with the Codex CLI binary itself, please refer to the official Codex documentation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Resources
+
+- [Official TypeScript SDK](https://github.com/anthropics/anthropic-sdk-typescript) (Reference)
+- [This Repository](https://github.com/ya-luotao/codex-sdk-ruby)
+
+## Support
+
+**Note**: This is an unofficial SDK. For questions about this Ruby SDK:
+- Open an issue on [GitHub](https://github.com/ya-luotao/codex-sdk-ruby/issues)
+
+For questions about the Codex CLI itself:
+- Refer to the official Codex CLI documentation

data/lib/codex_sdk/codex.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'thread'
+require_relative 'process_manager'
+require_relative 'options'
+
+module CodexSdk
+  # Main entry point for the Codex SDK
+  # Factory for creating and resuming threads
+  class Codex
+    def initialize(options = {})
+      @process_manager = ProcessManager.new(options[:codex_path_override])
+      @options = CodexOptions.new(options)
+    end
+
+    # Creates a new conversation thread
+    #
+    # @param options [Hash] Thread configuration options
+    # @option options [String] :model The model to use
+    # @option options [String] :sandbox_mode Sandbox mode (read-only, workspace-write, danger-full-access)
+    # @option options [String] :working_directory Working directory for the thread
+    # @option options [Boolean] :skip_git_repo_check Whether to skip git repo check
+    # @return [Thread] A new thread instance
+    def start_thread(options = {})
+      thread_options = ThreadOptions.new(options)
+      Thread.new(@process_manager, @options, thread_options)
+    end
+
+    # Resumes an existing conversation thread by ID
+    #
+    # @param thread_id [String] The thread ID to resume
+    # @param options [Hash] Thread configuration options
+    # @option options [String] :model The model to use
+    # @option options [String] :sandbox_mode Sandbox mode
+    # @option options [String] :working_directory Working directory for the thread
+    # @option options [Boolean] :skip_git_repo_check Whether to skip git repo check
+    # @return [Thread] A thread instance for the resumed thread
+    def resume_thread(thread_id, options = {})
+      thread_options = ThreadOptions.new(options)
+      Thread.new(@process_manager, @options, thread_options, id: thread_id)
+    end
+  end
+end

data/lib/codex_sdk/errors.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CodexSdk
+  # Base error class for all CodexSdk errors
+  class Error < StandardError; end
+
+  # Error raised when thread operations fail
+  class ThreadError < Error; end
+
+  # Error raised when process management fails
+  class ProcessError < Error; end
+
+  # Error raised when invalid options are provided
+  class InvalidOptionsError < Error; end
+
+  # Error raised when validation fails
+  class ValidationError < Error; end
+end

data/lib/codex_sdk/events.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CodexSdk
+  # Event types emitted by the Codex CLI
+  module EventTypes
+    THREAD_STARTED = "thread.started"
+    TURN_STARTED = "turn.started"
+    TURN_COMPLETED = "turn.completed"
+    TURN_FAILED = "turn.failed"
+    ITEM_STARTED = "item.started"
+    ITEM_UPDATED = "item.updated"
+    ITEM_COMPLETED = "item.completed"
+    ERROR = "error"
+
+    ALL_TYPES = [
+      THREAD_STARTED,
+      TURN_STARTED,
+      TURN_COMPLETED,
+      TURN_FAILED,
+      ITEM_STARTED,
+      ITEM_UPDATED,
+      ITEM_COMPLETED,
+      ERROR
+    ].freeze
+  end
+end

data/lib/codex_sdk/items.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module CodexSdk
+  # Item types that can appear in Codex conversations
+  module ItemTypes
+    AGENT_MESSAGE = "agent_message"
+    REASONING = "reasoning"
+    COMMAND_EXECUTION = "command_execution"
+    FILE_CHANGE = "file_change"
+    MCP_TOOL_CALL = "mcp_tool_call"
+    WEB_SEARCH = "web_search"
+    TODO_LIST = "todo_list"
+    ERROR = "error"
+
+    ALL_TYPES = [
+      AGENT_MESSAGE,
+      REASONING,
+      COMMAND_EXECUTION,
+      FILE_CHANGE,
+      MCP_TOOL_CALL,
+      WEB_SEARCH,
+      TODO_LIST,
+      ERROR
+    ].freeze
+  end
+
+  # Status values for command execution items
+  module CommandExecutionStatus
+    IN_PROGRESS = "in_progress"
+    COMPLETED = "completed"
+    FAILED = "failed"
+  end
+
+  # Kinds of file changes in patches
+  module PatchChangeKind
+    ADD = "add"
+    DELETE = "delete"
+    UPDATE = "update"
+  end
+
+  # Status values for patch apply operations
+  module PatchApplyStatus
+    COMPLETED = "completed"
+    FAILED = "failed"
+  end
+
+  # Status values for MCP tool calls
+  module McpToolCallStatus
+    IN_PROGRESS = "in_progress"
+    COMPLETED = "completed"
+    FAILED = "failed"
+  end
+end

data/lib/codex_sdk/options.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module CodexSdk
+  # Configuration options for the Codex SDK
+  class CodexOptions
+    attr_reader :codex_path_override, :base_url, :api_key
+
+    def initialize(options = {})
+      @codex_path_override = options[:codex_path_override]
+      @base_url = options[:base_url]
+      @api_key = options[:api_key]
+    end
+  end
+
+  # Configuration options for a Codex thread
+  class ThreadOptions
+    attr_reader :model, :sandbox_mode, :working_directory, :skip_git_repo_check
+
+    # Valid sandbox modes
+    VALID_SANDBOX_MODES = %w[read-only workspace-write danger-full-access].freeze
+
+    def initialize(options = {})
+      @model = options[:model]
+      @sandbox_mode = options[:sandbox_mode]
+      @working_directory = options[:working_directory]
+      @skip_git_repo_check = options[:skip_git_repo_check] || false
+
+      validate_sandbox_mode if @sandbox_mode
+    end
+
+    private
+
+    def validate_sandbox_mode
+      return if VALID_SANDBOX_MODES.include?(@sandbox_mode)
+
+      raise InvalidOptionsError, "Invalid sandbox_mode: #{@sandbox_mode}. " \
+                                 "Must be one of: #{VALID_SANDBOX_MODES.join(', ')}"
+    end
+  end
+
+  # Configuration options for a single turn in a thread
+  class TurnOptions
+    attr_reader :output_schema
+
+    def initialize(options = {})
+      @output_schema = options[:output_schema]
+    end
+  end
+end

data/lib/codex_sdk/process_manager.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'json'
+require 'rbconfig'
+
+module CodexSdk
+  # Manages spawning and communicating with the Codex CLI process
+  class ProcessManager
+    ORIGINATOR_ENV = "CODEX_INTERNAL_ORIGINATOR_OVERRIDE"
+    SDK_ORIGINATOR = "codex_sdk_ruby"
+
+    def initialize(executable_path = nil)
+      @executable_path = executable_path || find_codex_path
+    end
+
+    # Runs the Codex CLI and yields JSONL events
+    #
+    # @param input [String] The user input to send to the CLI
+    # @param base_url [String, nil] Optional API base URL
+    # @param api_key [String, nil] Optional API key
+    # @param thread_id [String, nil] Optional thread ID for resumption
+    # @param model [String, nil] Optional model name
+    # @param sandbox_mode [String, nil] Optional sandbox mode
+    # @param working_directory [String, nil] Optional working directory
+    # @param skip_git_repo_check [Boolean] Whether to skip git repo check
+    # @param output_schema_file [String, nil] Optional path to output schema file
+    # @return [Enumerator] An enumerator of JSONL event strings
+    def run(input:, base_url: nil, api_key: nil, thread_id: nil, model: nil,
+            sandbox_mode: nil, working_directory: nil, skip_git_repo_check: false,
+            output_schema_file: nil)
+
+      Enumerator.new do |yielder|
+        command_args = build_command_args(
+          thread_id: thread_id,
+          model: model,
+          sandbox_mode: sandbox_mode,
+          working_directory: working_directory,
+          skip_git_repo_check: skip_git_repo_check,
+          output_schema_file: output_schema_file
+        )
+
+        env = build_environment(base_url: base_url, api_key: api_key)
+
+        Open3.popen3(env, @executable_path, *command_args) do |stdin, stdout, stderr, wait_thr|
+          stdin.write(input)
+          stdin.close
+
+          stderr_chunks = []
+
+          # Read stderr in separate thread to avoid deadlock
+          stderr_thread = Thread.new do
+            stderr.each_line { |line| stderr_chunks << line }
+          end
+
+          # Stream lines from stdout
+          stdout.each_line do |line|
+            yielder << line.chomp
+          end
+
+          stderr_thread.join
+
+          exit_status = wait_thr.value
+          unless exit_status.success?
+            stderr_output = stderr_chunks.join("")
+            raise ProcessError, "Codex process exited with code #{exit_status.exitstatus}: #{stderr_output}"
+          end
+        end
+      end
+    end
+
+    private
+
+    def build_command_args(thread_id: nil, model: nil, sandbox_mode: nil,
+                          working_directory: nil, skip_git_repo_check: false,
+                          output_schema_file: nil)
+      args = ["exec", "--experimental-json"]
+
+      args.push("--model", model) if model
+      args.push("--sandbox", sandbox_mode) if sandbox_mode
+      args.push("--cd", working_directory) if working_directory
+      args.push("--skip-git-repo-check") if skip_git_repo_check
+      args.push("--output-schema", output_schema_file) if output_schema_file
+      args.push("resume", thread_id) if thread_id
+
+      args
+    end
+
+    def build_environment(base_url: nil, api_key: nil)
+      env = ENV.to_h.dup
+
+      env[ORIGINATOR_ENV] = SDK_ORIGINATOR unless env[ORIGINATOR_ENV]
+      env["OPENAI_BASE_URL"] = base_url if base_url
+      env["CODEX_API_KEY"] = api_key if api_key
+
+      env
+    end
+
+    def find_codex_path
+      platform = RUBY_PLATFORM
+      arch = RbConfig::CONFIG['host_cpu']
+
+      target_triple = case platform
+                      when /linux/
+                        case arch
+                        when /x86_64/, /x64/
+                          "x86_64-unknown-linux-musl"
+                        when /aarch64/, /arm64/
+                          "aarch64-unknown-linux-musl"
+                        end
+                      when /darwin/, /mac/
+                        case arch
+                        when /x86_64/, /x64/
+                          "x86_64-apple-darwin"
+                        when /aarch64/, /arm64/
+                          "aarch64-apple-darwin"
+                        end
+                      when /win32/, /cygwin/
+                        case arch
+                        when /x86_64/, /x64/
+                          "x86_64-pc-windows-msvc"
+                        when /aarch64/, /arm64/
+                          "aarch64-pc-windows-msvc"
+                        end
+                      end
+
+      raise ProcessError, "Unsupported platform: #{platform} (#{arch})" unless target_triple
+
+      # Determine binary name
+      binary_name = if platform.include?("win32") || platform.include?("cygwin")
+                      "codex.exe"
+                    else
+                      "codex"
+                    end
+
+      # Build path to bundled binary
+      gem_root = File.expand_path("../..", __dir__)
+      vendor_root = File.join(gem_root, "vendor")
+      arch_root = File.join(vendor_root, target_triple)
+      File.join(arch_root, "codex", binary_name)
+    end
+  end
+end

data/lib/codex_sdk/thread.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'tempfile'
+require 'fileutils'
+
+module CodexSdk
+  # Represents a conversation thread with the Codex agent
+  class Thread
+    attr_reader :id
+
+    def initialize(process_manager, codex_options, thread_options, id: nil)
+      @process_manager = process_manager
+      @codex_options = codex_options
+      @thread_options = thread_options
+      @id = id
+    end
+
+    # Runs a turn and returns the aggregated result
+    #
+    # @param input [String] The user input message
+    # @param turn_options [Hash] Options for this turn
+    # @option turn_options [Hash] :output_schema JSON schema for structured output
+    # @return [Hash] Result containing :items, :final_response, and :usage
+    def run(input, turn_options = {})
+      items = []
+      final_response = ""
+      usage = nil
+      turn_failure = nil
+
+      run_streamed(input, turn_options).each do |event|
+        case event['type']
+        when 'item.completed'
+          item = event['item']
+          final_response = item['text'] if item['type'] == 'agent_message'
+          items << item
+        when 'turn.completed'
+          usage = event['usage']
+        when 'turn.failed'
+          turn_failure = event['error']
+          break
+        end
+      end
+
+      raise ThreadError, turn_failure['message'] if turn_failure
+
+      {
+        items: items,
+        final_response: final_response,
+        usage: usage
+      }
+    end
+
+    # Runs a turn and yields events as they arrive
+    #
+    # @param input [String] The user input message
+    # @param turn_options [Hash] Options for this turn
+    # @option turn_options [Hash] :output_schema JSON schema for structured output
+    # @return [Enumerator] An enumerator of event hashes
+    def run_streamed(input, turn_options = {})
+      Enumerator.new do |yielder|
+        schema_path = nil
+        cleanup_proc = nil
+
+        begin
+          schema_path, cleanup_proc = create_output_schema(turn_options[:output_schema])
+
+          @process_manager.run(
+            input: input,
+            base_url: @codex_options.base_url,
+            api_key: @codex_options.api_key,
+            thread_id: @id,
+            model: @thread_options.model,
+            sandbox_mode: @thread_options.sandbox_mode,
+            working_directory: @thread_options.working_directory,
+            skip_git_repo_check: @thread_options.skip_git_repo_check,
+            output_schema_file: schema_path
+          ).each do |line|
+            event = JSON.parse(line)
+
+            @id = event['thread_id'] if event['type'] == 'thread.started'
+
+            yielder << event
+          end
+        ensure
+          cleanup_proc&.call
+        end
+      end
+    end
+
+    private
+
+    def create_output_schema(schema)
+      return [nil, nil] unless schema
+
+      unless schema.is_a?(Hash)
+        raise ValidationError, "outputSchema must be a plain JSON object"
+      end
+
+      temp_dir = Dir.mktmpdir("codex-output-schema-")
+      schema_path = File.join(temp_dir, "schema.json")
+
+      File.write(schema_path, JSON.generate(schema))
+
+      cleanup_proc = lambda do
+        FileUtils.rm_rf(temp_dir, secure: true) if Dir.exist?(temp_dir)
+      end
+
+      [schema_path, cleanup_proc]
+    rescue StandardError => e
+      FileUtils.rm_rf(temp_dir, secure: true) if temp_dir && Dir.exist?(temp_dir)
+      raise e
+    end
+  end
+end

data/lib/codex_sdk/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CodexSdk
+  VERSION = "0.1.0"
+end

data/lib/codex_sdk.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'codex_sdk/version'
+require_relative 'codex_sdk/errors'
+require_relative 'codex_sdk/events'
+require_relative 'codex_sdk/items'
+require_relative 'codex_sdk/options'
+require_relative 'codex_sdk/process_manager'
+require_relative 'codex_sdk/thread'
+require_relative 'codex_sdk/codex'
+
+# Unofficial Ruby SDK for Codex CLI
+#
+# This is an unofficial, community-maintained SDK that wraps the Codex CLI binary.
+# It is not officially maintained or supported.
+#
+# Based on the official TypeScript SDK architecture.
+module CodexSdk
+  class << self
+    # Creates a new Codex instance
+    #
+    # @param options [Hash] Configuration options
+    # @option options [String] :api_key API key for authentication
+    # @option options [String] :base_url Base URL for the API
+    # @option options [String] :codex_path_override Path to codex binary (for testing)
+    # @return [Codex] A new Codex instance
+    def new(options = {})
+      Codex.new(options)
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: codex-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tao Luo
+bindir: exe
+cert_chain: []
+date: 2025-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  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
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Unofficial Ruby SDK that wraps the Codex CLI binary. Embed the Codex
+  agent in your Ruby workflows and apps.
+email:
+- your-email@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/codex_sdk.rb
+- lib/codex_sdk/codex.rb
+- lib/codex_sdk/errors.rb
+- lib/codex_sdk/events.rb
+- lib/codex_sdk/items.rb
+- lib/codex_sdk/options.rb
+- lib/codex_sdk/process_manager.rb
+- lib/codex_sdk/thread.rb
+- lib/codex_sdk/version.rb
+homepage: https://github.com/ya-luotao/codex-sdk-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ya-luotao/codex-sdk-ruby
+  source_code_uri: https://github.com/ya-luotao/codex-sdk-ruby
+  changelog_uri: https://github.com/ya-luotao/codex-sdk-ruby/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Unofficial Ruby SDK for Codex CLI
+test_files: []