ruby_llm-codex 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 327d1024d1312946be5cef27e896917d610f29371fe838ba21a40cc5cf1523f5
-  data.tar.gz: f190f12cf2162290765030c0c8e52bf0991c2a642d1a12ed22cd2166c0db4a50
+  metadata.gz: 5f3eefeb5765f92ebb369bea19cb8ff7381b47c1fc2f757cdd81e198026c55a5
+  data.tar.gz: cec55121b1997e4f19e658d8bddb449d9d62184a23064133b0ed43c1cf121ba6
 SHA512:
-  metadata.gz: fbf552d4a8596b68e144d02d8b211a4809171acdb2f851b8d6153e80472ad7fa5a1526531fb1845815a99419e8625478d73424bd3335e1e2e5166f4a17d3396b
-  data.tar.gz: e6cd50256c38eed094841185861338d538e66b4386f83043d11ba32e5b54f73a0759ced535111e11a60d874cff8247ac9428404481bd750fd0a8d81eca209856
+  metadata.gz: 44d0e1b40099748a684affdbcdfedecbdfb390ed99371ac1b6cd1168a88859bfde31a19091300da3c5d5f57391fab23410283926fbab1451545904c84adafd34
+  data.tar.gz: 1b66678e5613e5a7c5a8b313786b3e1e6e42e57fa9adb5ea140832164e40e2cecb5d805287004ebd1e1f3827535136588ad1d518bf14d55cc3a87055c9b31c41

data/CHANGELOG.md

@@ -5,6 +5,24 @@ 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.5.0] - 2026-11-08
+
+
+### Changed
+
+- keep checks local and adopt Gemkit 0.3.1
+
+
+
+
+### Documentation
+
+- make Ethos Link the canonical documentation home
+
+- keep audited technical guidance alongside the code
+
+
+
 ## [0.4.1] - 2026-11-05
 
 

data/README.md

@@ -1,6 +1,6 @@
 # RubyLLM Codex provider
 
-[![Ruby](https://github.com/ethos-link/ruby_llm-codex/actions/workflows/ruby.yml/badge.svg)](https://github.com/ethos-link/ruby_llm-codex/actions/workflows/ruby.yml)
+[![Commit messages](https://github.com/ethos-link/ruby_llm-codex/actions/workflows/commitlint.yml/badge.svg)](https://github.com/ethos-link/ruby_llm-codex/actions/workflows/commitlint.yml)
 [![Gem Version](https://badge.fury.io/rb/ruby_llm-codex.svg)](https://rubygems.org/gems/ruby_llm-codex)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
 
@@ -16,6 +16,12 @@ API. Codex applies its own base instructions and runtime behavior. RubyLLM syste
 messages are passed as Codex developer instructions, which is the closest
 supported mapping but not an identical wire-level request.
 
+## Documentation
+
+This README and the linked repository guides describe the checked-out code.
+The [Ethos Link project page](https://www.ethos-link.com/opensource/ruby-llm-codex)
+provides the canonical public project guide, overview and resources.
+
 ## Requirements
 
 - Ruby 4.0 or newer
@@ -50,7 +56,25 @@ Then run `bundle install`. You can also install it directly:
 gem install ruby_llm-codex
 ```
 
-## Usage
+## Quick start
+
+Set `CODEX_MODEL` to a model available to the account configured by
+`codex login`, then run:
+
+```ruby
+require "ruby_llm-codex"
+
+response = RubyLLM.chat(
+  model: ENV.fetch("CODEX_MODEL"), provider: :codex
+).ask("Reply with a short greeting.")
+
+puts response.content
+```
+
+Each request starts a local `codex exec` process. Its output and usage depend on
+the selected model and account; the gem does not provide its own model list.
+
+## Structured output
 
 Require the gem and use Codex as an explicit RubyLLM provider:
 
@@ -89,8 +113,10 @@ By default every request:
 - passes RubyLLM's system instruction as Codex developer instructions;
 - passes RubyLLM's JSON schema through `--output-schema`.
 
-This prevents local `AGENTS.md`, plugins, MCP servers, repository contents, and
-saved session history from quietly affecting a request.
+These defaults separate the request from the current repository and user
+configuration. Supplying a working directory, profile or user configuration
+changes that context deliberately; the adapter still runs the Codex harness.
+Sandbox behaviour also depends on the installed CLI and host platform.
 
 ## Configuration
 
@@ -99,6 +125,8 @@ saved session history from quietly affecting a request.
 To deliberately let Codex inspect a repository or use selected configuration:
 
 ```ruby
+chat = RubyLLM.chat(model: ENV.fetch("CODEX_MODEL"), provider: :codex)
+
 chat.with_provider_options(
   codex: {
     working_directory: "/path/to/project",
@@ -148,9 +176,8 @@ instructions. Those settings, plus `features.shell_snapshot` and
   One-shot `with_instructions(...).ask(...)` requests have the most direct
   semantic mapping.
 
-If you later need streaming, persistent threads, or high throughput, replace
-the process-per-request implementation with a long-running `codex app-server`
-client while keeping the same RubyLLM provider surface.
+Streaming, persistent threads and a long-running app-server client are not
+implemented by this gem.
 
 ## Troubleshooting
 
@@ -191,3 +218,15 @@ The optional `codex:smoke` task requires your Codex account, an available
 
 Release preparation, publication, registry setup and recovery are documented
 in the [Gemkit release guide](https://github.com/ethos-link/ethos-gemkit#releasing-a-gem).
+
+## About Ethos Link
+
+[Ethos Link](https://www.ethos-link.com) is a software company founded by
+[Paulo Fidalgo](https://www.fidalgo.pt). This gem is part of the open-source
+tooling we publish alongside our business products:
+
+- [Reviato](https://www.reviato.com): collect private customer feedback and analyse public reviews.
+- [Nuntio](https://www.nuntiohq.com): prepare, review and schedule social posts.
+- [EthosPlaces](https://www.ethos.place): find places, opening hours and contact details.
+
+Explore our [open-source projects](https://www.ethos-link.com/opensource).

data/UPGRADE.md

@@ -1,10 +1,13 @@
 # Upgrade Guide
 
+Run `bundle exec rake verify` locally before pushing or preparing a release.
+GitHub Actions runs commitlint and release packaging/publication only.
+
 ## 0.4.0
 
 ### Shared development and release tooling
 
-Use Ruby 4 and published Gemkit 0.3.0. Install the bundle and hooks, then run the
+Use Ruby 4 and published Gemkit 0.3.1. Install the bundle and hooks, then run the
 project's verification command from the README. Prepare releases from clean,
 current main; merging the generated release PR publishes through Actions.
 See the [Gemkit upgrade guide](https://github.com/ethos-link/ethos-gemkit/blob/main/UPGRADE.md)

data/lib/ruby_llm/codex/version.rb

@@ -2,6 +2,6 @@
 
 module RubyLLM
   module Codex
-    VERSION = "0.4.1"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_llm-codex
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Paulo Fidalgo
@@ -55,15 +55,15 @@ files:
 - lib/ruby_llm-codex.rb
 - lib/ruby_llm/codex/version.rb
 - lib/ruby_llm/providers/codex.rb
-homepage: https://github.com/ethos-link/ruby_llm-codex
+homepage: https://www.ethos-link.com/opensource/ruby-llm-codex
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/ethos-link/ruby_llm-codex
+  homepage_uri: https://www.ethos-link.com/opensource/ruby-llm-codex
   source_code_uri: https://github.com/ethos-link/ruby_llm-codex
   bug_tracker_uri: https://github.com/ethos-link/ruby_llm-codex/issues
   changelog_uri: https://github.com/ethos-link/ruby_llm-codex/blob/main/CHANGELOG.md
-  documentation_uri: https://github.com/ethos-link/ruby_llm-codex/blob/main/README.md
+  documentation_uri: https://www.ethos-link.com/opensource/ruby-llm-codex
   funding_uri: https://www.reviato.com/
   github_repo: ssh://github.com/ethos-link/ruby_llm-codex
   allowed_push_host: https://rubygems.org