Update documentation for OpenRouter support

Author: crmne

.github/workflows/cicd.yml

@@ -128,6 +128,7 @@ jobs:
         ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
         GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}
         DEEPSEEK_API_KEY: ${{ secrets.DEEPSEEK_API_KEY }}
+        OPENROUTER_API_KEY: ${{ secrets.OPENROUTER_API_KEY }}
         AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
         AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
 

README.md

@@ -12,6 +12,9 @@ A delightful Ruby way to work with AI. No configuration madness, no complex call
   <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/bedrock-color.svg" alt="Bedrock" height="40">
   <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/bedrock-text.svg" alt="Bedrock" height="40" width="120">
   &nbsp;&nbsp;
+  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/openrouter.svg" alt="OpenRouter" height="40">
+  <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/openrouter-text.svg" alt="OpenRouter" height="40" width="120">
+  &nbsp;&nbsp;
   <img src="https://upload.wikimedia.org/wikipedia/commons/e/ec/DeepSeek_logo.svg" alt="DeepSeek" height="40" width="120">
 </div>
 
@@ -30,7 +33,7 @@ RubyLLM fixes all that. One beautiful API for everything. One consistent format.
 
 ## Features
 
-- 💬 **Chat** with OpenAI, Anthropic, Gemini, AWS Bedrock Anthropic, and DeepSeek models
+- 💬 **Chat** with OpenAI, Anthropic, Gemini, AWS Bedrock Anthropic, OpenRouter, and DeepSeek models
 - 👁️ **Vision and Audio** understanding
 - 📄 **PDF Analysis** for analyzing documents
 - 🖼️ **Image generation** with DALL-E and other providers

bin/console

@@ -12,11 +12,11 @@ RubyLLM.configure do |config|
   config.anthropic_api_key = ENV.fetch('ANTHROPIC_API_KEY', nil)
   config.gemini_api_key = ENV.fetch('GEMINI_API_KEY', nil)
   config.deepseek_api_key = ENV.fetch('DEEPSEEK_API_KEY', nil)
+  config.openrouter_api_key = ENV.fetch('OPENROUTER_API_KEY', nil)
   config.bedrock_api_key = ENV.fetch('AWS_ACCESS_KEY_ID', nil)
   config.bedrock_secret_key = ENV.fetch('AWS_SECRET_ACCESS_KEY', nil)
   config.bedrock_region = ENV.fetch('AWS_REGION', nil)
   config.bedrock_session_token = ENV.fetch('AWS_SESSION_TOKEN', nil)
-  config.openrouter_api_key = ENV.fetch('OPENROUTER_API_KEY', nil)
 end
 
 IRB.start(__FILE__)

docs/configuration.md

@@ -30,6 +30,11 @@ After reading this guide, you will know:
 
 ## Global Configuration (`RubyLLM.configure`)
 
+{: .note-title }
+> Coming in v1.3.0
+>
+> OpenRouter support is coming in v1.3.0
+
 The primary way to configure RubyLLM is using the `RubyLLM.configure` block. This typically runs once when your application starts (e.g., in `config/initializers/ruby_llm.rb` for Rails apps, or at the top of a script).
 
 ```ruby
@@ -43,6 +48,7 @@ RubyLLM.configure do |config|
   config.anthropic_api_key = ENV.fetch('ANTHROPIC_API_KEY', nil)
   config.gemini_api_key = ENV.fetch('GEMINI_API_KEY', nil)
   config.deepseek_api_key = ENV.fetch('DEEPSEEK_API_KEY', nil)
+  config.openrouter_api_key = ENV.fetch('OPENROUTER_API_KEY', nil)
 
   # --- AWS Bedrock Credentials ---
   # Uses standard AWS credential chain (environment, shared config, IAM role)
@@ -82,6 +88,7 @@ Set the corresponding `*_api_key` attribute for each provider you want to enable
 *   `anthropic_api_key`
 *   `gemini_api_key`
 *   `deepseek_api_key`
+*   `openrouter_api_key`
 *   `bedrock_api_key`, `bedrock_secret_key`, `bedrock_region`, `bedrock_session_token` (See AWS documentation for standard credential methods if not set explicitly).
 
 ## Custom OpenAI API Base (`openai_api_base`)
@@ -128,8 +135,8 @@ Adjust these based on network conditions and provider reliability.
 ## Scoped Configuration with Contexts
 {: .d-inline-block }
 
-New (v1.3.0)
-{: .label .label-green }
+Coming in v1.3.0
+{: .label .label-yellow }
 
 While `RubyLLM.configure` sets global defaults, `RubyLLM.context` allows you to create temporary, isolated configuration scopes for specific API calls. This is ideal for situations requiring different keys, endpoints, or timeouts temporarily without affecting the rest of the application.
 

docs/guides/models.md

@@ -9,7 +9,7 @@ permalink: /guides/models
 # Working with AI Models
 {: .no_toc }
 
-RubyLLM provides a unified interface to a wide array of AI models from different providers like OpenAI, Anthropic, Google, AWS Bedrock, and DeepSeek. This guide covers how RubyLLM discovers, manages, and allows you to interact with these models, including advanced scenarios like custom endpoints.
+RubyLLM provides a unified interface to a wide array of AI models from different providers like OpenAI, Anthropic, Google, AWS Bedrock, OpenRouter and DeepSeek. This guide covers how RubyLLM discovers, manages, and allows you to interact with these models, including advanced scenarios like custom endpoints.
 {: .fs-6 .fw-300 }
 
 ## Table of contents

docs/index.md

@@ -12,7 +12,7 @@ permalink: /
   <iframe src="https://ghbtns.com/github-btn.html?user=crmne&repo=ruby_llm&type=star&count=true&size=large" frameborder="0" scrolling="0" width="170" height="30" title="GitHub" style="vertical-align: middle; display: inline-block;"></iframe>
 </div>
 
-A delightful Ruby way to work with AI through a unified interface to OpenAI, Anthropic, Google, AWS Bedrock Anthropic, and DeepSeek.
+A delightful Ruby way to work with AI through a unified interface to OpenAI, Anthropic, Google, AWS Bedrock Anthropic, OpenRouter, and DeepSeek.
 {: .fs-6 .fw-300 }
 
 
@@ -29,6 +29,10 @@ A delightful Ruby way to work with AI through a unified interface to OpenAI, Ant
     <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/bedrock-color.svg" alt="Bedrock" height="40">
     <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/bedrock-text.svg" alt="Bedrock" height="40" width="120">
   </div>
+  <div>
+    <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/openrouter.svg" alt="OpenRouter" height="40">
+    <img src="https://registry.npmmirror.com/@lobehub/icons-static-svg/latest/files/icons/openrouter-text.svg" alt="OpenRouter" height="40" width="120">
+  </div>
   <img src="https://upload.wikimedia.org/wikipedia/commons/e/ec/DeepSeek_logo.svg" alt="DeepSeek" height="40" width="120">
 </div>
 
@@ -52,7 +56,7 @@ RubyLLM fixes all that. One beautiful API for everything. One consistent format.
 
 ## Features
 
-- 💬 **Chat** with OpenAI, Anthropic, Gemini, AWS Bedrock Anthropic, and DeepSeek models
+- 💬 **Chat** with OpenAI, Anthropic, Gemini, AWS Bedrock Anthropic, OpenRouter, and DeepSeek models
 - 👁️ **Vision and Audio** understanding
 - 📄 **PDF Analysis** for analyzing documents
 - 🖼️ **Image generation** with DALL-E and other providers

ruby_llm.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Beautiful Ruby interface to modern AI'
   spec.description   = 'A delightful Ruby way to work with AI. Chat in text, analyze and generate ' \
                        'images, understand audio, and use tools through a unified interface to ' \
-                       'OpenAI, Anthropic, Google, AWS Bedrock Anthropic, and DeepSeek. Built for ' \
+                       'OpenAI, Anthropic, Google, AWS Bedrock Anthropic, OpenRouter, and DeepSeek. Built for ' \
                        'developer happiness with automatic token counting, proper streaming, and ' \
                        'Rails integration. No wrapping your head around multiple APIs - just clean ' \
                        'Ruby code that works.'