girb 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3444545df799e66732b89937b28d45758677db42c567c855b18bbea51bb09a63
-  data.tar.gz: bc5b78829ab8739e2add32cd2aedc139705d749db0efe176b25e1da1dce25822
+  metadata.gz: 69a7d9cee0ae606d21d75c1fc94c1aef3665c8e38e4f704c9e8f899d7e70b943
+  data.tar.gz: 898823b1d088a67f8adb5e93705bb547d623eb0564d1831fe39cfa98757e233e
 SHA512:
-  metadata.gz: 2a2b5fa25eab058edcc21e8ef06b95b1df8ca256ff5608fe89fe72eac7056429894e1b665087ca46e5dfc32586097e4e78652dfa59a3d92a008a7c981ab042c4
-  data.tar.gz: 770e74219dadc08011320fd3b48c8ad231055ccb0ed5827bce2221042cc8208b0eaca094015a4786bbfd6306a843df9d255106ca3f17659b5027df6ce6e85acf
+  metadata.gz: 93e107025ea0480db5b0403531a3af424836dfbef23a7f7f174e8c89036b1b3d140571ba0334a3c2f1ff7fda89ab91df2c5478f18f945474fd1ca836eb3ae5c3
+  data.tar.gz: bd5097cc780074724642e3c2932d23178eea0140e6bdd9460489abb97a0ac3f567577d1ecd6153d29ef896ed6803ed9c1988995d64ffd47db3c08dac702f6b21

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.1.2] - 2026-02-03
+
+### Added
+
+- `.girbrc` configuration file support with directory traversal
+- Railtie for automatic Rails console integration
+- GirbrcLoader utility for finding and loading `.girbrc` files
+
+### Changed
+
+- Recommend `.girbrc` configuration instead of `~/.irbrc`
+- `girb` command now loads `.girbrc` before falling back to environment variables
+
 ## [0.1.1] - 2026-02-03
 
 ### Changed

data/README.md

@@ -16,11 +16,14 @@ An AI assistant embedded in your IRB session. It understands your runtime contex
 
 ## Installation
 
+### For Rails Projects
+
 Add to your Gemfile:
 
 ```ruby
-gem 'girb'
-gem 'girb-ruby_llm'  # or girb-gemini
+group :development do
+  gem 'girb-ruby_llm'  # or girb-gemini
+end
 ```
 
 Then run:
@@ -29,84 +32,76 @@ Then run:
 bundle install
 ```
 
-Or install directly:
-
-```bash
-gem install girb girb-ruby_llm
-```
+Create a `.girbrc` file in your project root:
 
-Set the provider via environment variable:
+```ruby
+# .girbrc
+require 'girb-ruby_llm'
 
-```bash
-export GIRB_PROVIDER=girb-ruby_llm
+Girb.configure do |c|
+  c.provider = Girb::Providers::RubyLlm.new(model: 'gemini-2.5-flash')
+end
 ```
 
-## Providers
-
-Currently available providers:
-
-- [girb-ruby_llm](https://github.com/rira100000000/girb-ruby_llm) - Multiple providers via RubyLLM (OpenAI, Anthropic, Gemini, Ollama, etc.)
-- [girb-gemini](https://github.com/rira100000000/girb-gemini) - Google Gemini
+Now `rails console` will automatically load girb!
 
-You can also [create your own provider](#custom-providers).
-
-## Setup
-
-### Using girb-ruby_llm (Recommended)
+### For Non-Rails Projects
 
-girb-ruby_llm supports multiple LLM providers through RubyLLM.
+Install globally:
 
 ```bash
 gem install girb girb-ruby_llm
 ```
 
-Add to your `~/.irbrc`:
+Create a `.girbrc` file in your project directory:
 
 ```ruby
+# .girbrc
 require 'girb-ruby_llm'
 
-RubyLLM.configure do |config|
-  config.gemini_api_key = 'your-api-key'
-end
-
 Girb.configure do |c|
   c.provider = Girb::Providers::RubyLlm.new(model: 'gemini-2.5-flash')
 end
 ```
 
-See [girb-ruby_llm README](https://github.com/rira100000000/girb-ruby_llm) for more options (OpenAI, Anthropic, Ollama, etc.).
+Then use `girb` command instead of `irb`.
 
-### Using girb-gemini
+## How .girbrc Works
 
-```bash
-gem install girb girb-gemini
-```
+girb searches for `.girbrc` in the following order:
 
-Add to your `~/.irbrc`:
+1. Current directory, then parent directories (up to root)
+2. `~/.girbrc` as fallback
 
-```ruby
-require 'girb-gemini'
+This allows you to:
 
-Girb.configure do |c|
-  c.provider = Girb::Providers::Gemini.new(
-    api_key: 'your-api-key',
-    model: 'gemini-2.5-flash'
-  )
-end
-```
+- **Project-specific settings**: Place `.girbrc` in your project root
+- **Shared settings**: Place `.girbrc` in a parent directory (e.g., `~/work/.girbrc` for all work projects)
+- **Global default**: Place `.girbrc` in your home directory
+
+## Providers
+
+Currently available providers:
+
+- [girb-ruby_llm](https://github.com/rira100000000/girb-ruby_llm) - Multiple providers via RubyLLM (OpenAI, Anthropic, Gemini, Ollama, etc.)
+- [girb-gemini](https://github.com/rira100000000/girb-gemini) - Google Gemini
+
+You can also [create your own provider](#custom-providers).
 
 ## Usage
 
-### Quick Start
+### For Rails Projects
 
 ```bash
-girb
+rails console
 ```
 
-Or add to your `~/.irbrc` for automatic loading with regular `irb`:
+girb is automatically loaded via Railtie.
 
-```ruby
-require 'girb-ruby_llm'  # or 'girb-gemini'
+### For Non-Rails Projects
+
+```bash
+girb
 ```
 
 ### Debug with binding.girb
@@ -139,7 +134,7 @@ irb(main):001> qq "How do I use this method?"
 
 ## Configuration Options
 
-Add to your `~/.irbrc`:
+Add to your `.girbrc`:
 
 ```ruby
 require 'girb-ruby_llm'
@@ -165,10 +160,12 @@ girb --help     # Show help
 
 ### Environment Variables
 
+For `girb` command, you can also configure via environment variables (used when no `.girbrc` is found):
+
 | Variable | Description |
 |----------|-------------|
-| `GIRB_PROVIDER` | **Required.** Provider gem to load (e.g., `girb-ruby_llm`, `girb-gemini`) |
-| `GIRB_MODEL` | Model to use (e.g., `gemini-2.5-flash`, `gpt-4o`). Required for girb-ruby_llm. |
+| `GIRB_PROVIDER` | Provider gem to load (e.g., `girb-ruby_llm`, `girb-gemini`) |
+| `GIRB_MODEL` | Model to use (e.g., `gemini-2.5-flash`, `gpt-4o`) |
 | `GIRB_DEBUG` | Set to `1` to enable debug output |
 
 ## Available Tools
@@ -220,12 +217,6 @@ Girb.configure do |c|
 end
 ```
 
-Then run with:
-
-```bash
-GIRB_PROVIDER=my_provider girb
-```
-
 ## Examples
 
 ### Debugging Assistance

data/README_ja.md

@@ -14,11 +14,14 @@ IRBセッションに組み込まれたAIアシスタント。実行中のコン
 
 ## インストール
 
+### Railsプロジェクトの場合
+
 Gemfileに追加:
 
 ```ruby
-gem 'girb'
-gem 'girb-ruby_llm'  # または girb-gemini
+group :development do
+  gem 'girb-ruby_llm'  # または girb-gemini
+end
 ```
 
 そして実行:
@@ -27,84 +30,76 @@ gem 'girb-ruby_llm'  # または girb-gemini
 bundle install
 ```
 
-または直接インストール:
-
-```bash
-gem install girb girb-ruby_llm
-```
+プロジェクトルートに `.girbrc` ファイルを作成:
 
-環境変数でプロバイダーを設定:
+```ruby
+# .girbrc
+require 'girb-ruby_llm'
 
-```bash
-export GIRB_PROVIDER=girb-ruby_llm
+Girb.configure do |c|
+  c.provider = Girb::Providers::RubyLlm.new(model: 'gemini-2.5-flash')
+end
 ```
 
-## プロバイダー
-
-現在利用可能なプロバイダー:
-
-- [girb-ruby_llm](https://github.com/rira100000000/girb-ruby_llm) - RubyLLM経由で複数プロバイダー対応（OpenAI、Anthropic、Gemini、Ollama等）
-- [girb-gemini](https://github.com/rira100000000/girb-gemini) - Google Gemini
+これで `rails console` が自動的にgirbを読み込みます！
 
-[独自プロバイダーの作成](#カスタムプロバイダー)も可能です。
-
-## セットアップ
-
-### girb-ruby_llmを使用する場合（推奨）
+### 非Railsプロジェクトの場合
 
-girb-ruby_llmはRubyLLMを通じて複数のLLMプロバイダーをサポートしています。
+グローバルにインストール:
 
 ```bash
 gem install girb girb-ruby_llm
 ```
 
-`~/.irbrc` に追加:
+プロジェクトディレクトリに `.girbrc` ファイルを作成:
 
 ```ruby
+# .girbrc
 require 'girb-ruby_llm'
 
-RubyLLM.configure do |config|
-  config.gemini_api_key = 'your-api-key'
-end
-
 Girb.configure do |c|
   c.provider = Girb::Providers::RubyLlm.new(model: 'gemini-2.5-flash')
 end
 ```
 
-詳細な設定（OpenAI、Anthropic、Ollama等）については [girb-ruby_llm README](https://github.com/rira100000000/girb-ruby_llm) を参照してください。
+`irb` の代わりに `girb` コマンドを使用します。
 
-### girb-geminiを使用する場合
+## .girbrc の仕組み
 
-```bash
-gem install girb girb-gemini
-```
+girbは以下の順序で `.girbrc` を探します:
 
-`~/.irbrc` に追加:
+1. カレントディレクトリから親ディレクトリを遡って探索（ルートまで）
+2. `~/.girbrc` にフォールバック
 
-```ruby
-require 'girb-gemini'
+これにより:
 
-Girb.configure do |c|
-  c.provider = Girb::Providers::Gemini.new(
-    api_key: 'your-api-key',
-    model: 'gemini-2.5-flash'
-  )
-end
-```
+- **プロジェクト固有の設定**: プロジェクトルートに `.girbrc` を配置
+- **共有設定**: 親ディレクトリに `.girbrc` を配置（例: `~/work/.girbrc` で仕事用プロジェクト全体に適用）
+- **グローバルデフォルト**: ホームディレクトリに `.girbrc` を配置
+
+## プロバイダー
+
+現在利用可能なプロバイダー:
+
+- [girb-ruby_llm](https://github.com/rira100000000/girb-ruby_llm) - RubyLLM経由で複数プロバイダー対応（OpenAI、Anthropic、Gemini、Ollama等）
+- [girb-gemini](https://github.com/rira100000000/girb-gemini) - Google Gemini
+
+[独自プロバイダーの作成](#カスタムプロバイダー)も可能です。
 
 ## 使い方
 
-### 起動方法
+### Railsプロジェクトの場合
 
 ```bash
-girb
+rails console
 ```
 
-または `~/.irbrc` に以下を追加すると、通常の `irb` コマンドでも使えます:
+Railtieにより自動的にgirbが読み込まれます。
 
-```ruby
-require 'girb-ruby_llm'  # または 'girb-gemini'
+### 非Railsプロジェクトの場合
+
+```bash
+girb
 ```
 
 ### binding.girbでデバッグ
@@ -137,7 +132,7 @@ irb(main):001> qq "このメソッドの使い方を教えて"
 
 ## 設定オプション
 
-`~/.irbrc` に追加:
+`.girbrc` に追加:
 
 ```ruby
 require 'girb-ruby_llm'
@@ -163,10 +158,12 @@ girb --help     # ヘルプを表示
 
 ### 環境変数
 
+`girb` コマンドでは、`.girbrc` が見つからない場合に環境変数で設定することもできます:
+
 | 変数 | 説明 |
 |------|------|
-| `GIRB_PROVIDER` | **必須。** 読み込むプロバイダーgem（例: `girb-ruby_llm`、`girb-gemini`） |
-| `GIRB_MODEL` | 使用するモデル（例: `gemini-2.5-flash`、`gpt-4o`）。girb-ruby_llmでは必須。 |
+| `GIRB_PROVIDER` | 読み込むプロバイダーgem（例: `girb-ruby_llm`、`girb-gemini`） |
+| `GIRB_MODEL` | 使用するモデル（例: `gemini-2.5-flash`、`gpt-4o`） |
 | `GIRB_DEBUG` | `1`に設定するとデバッグ出力を有効化 |
 
 ## AIが使用できるツール
@@ -218,12 +215,6 @@ Girb.configure do |c|
 end
 ```
 
-実行:
-
-```bash
-GIRB_PROVIDER=my_provider girb
-```
-
 ## 使用例
 
 ### デバッグ支援

data/exe/girb

@@ -21,18 +21,25 @@ ENV["GIRB_DEBUG"] = "1" if options[:debug]
 
 require "irb"
 
-# Load girb and provider
+# Load girb
 require "girb"
 
-if ENV["GIRB_PROVIDER"]
-  begin
-    require ENV["GIRB_PROVIDER"]
-  rescue LoadError
-    warn "[girb] Failed to load provider: #{ENV["GIRB_PROVIDER"]}"
+# Load .girbrc (searches from current directory up to root, then ~/.girbrc)
+girbrc_loaded = Girb::GirbrcLoader.load_girbrc
+
+# If no .girbrc found, try environment variable based configuration
+unless girbrc_loaded
+  if ENV["GIRB_PROVIDER"]
+    begin
+      require ENV["GIRB_PROVIDER"]
+    rescue LoadError
+      warn "[girb] Failed to load provider: #{ENV["GIRB_PROVIDER"]}"
+    end
+  else
+    warn "[girb] No .girbrc found and GIRB_PROVIDER not set."
+    warn "[girb]   Create a .girbrc file or set GIRB_PROVIDER environment variable."
+    warn "[girb]   Example: GIRB_PROVIDER=girb-ruby_llm girb"
   end
-else
-  warn "[girb] No provider specified. Set GIRB_PROVIDER environment variable."
-  warn "[girb]   Example: GIRB_PROVIDER=girb-ruby_llm girb"
 end
 
 IRB.start

data/lib/girb/ai_client.rb

@@ -53,7 +53,8 @@ module Girb
         response = @provider.chat(
           messages: messages,
           system_prompt: @system_prompt,
-          tools: tools
+          tools: tools,
+          binding: @current_binding
         )
 
         if Girb.configuration.debug

data/lib/girb/girbrc_loader.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module Girb
+  module GirbrcLoader
+    class << self
+      # Find .girbrc by traversing from start_dir up to root,
+      # then fall back to ~/.girbrc
+      def find_girbrc(start_dir = Dir.pwd)
+        dir = Pathname.new(start_dir).expand_path
+
+        # Traverse up to find .girbrc
+        while dir != dir.parent
+          candidate = dir.join(".girbrc")
+          return candidate if candidate.exist?
+          dir = dir.parent
+        end
+
+        # Check root directory
+        root_candidate = dir.join(".girbrc")
+        return root_candidate if root_candidate.exist?
+
+        # Fall back to ~/.girbrc
+        home_girbrc = Pathname.new(File.expand_path("~/.girbrc"))
+        home_girbrc.exist? ? home_girbrc : nil
+      end
+
+      # Load .girbrc if found
+      def load_girbrc(start_dir = Dir.pwd)
+        girbrc = find_girbrc(start_dir)
+        return false unless girbrc
+
+        if Girb.configuration&.debug
+          warn "[girb] Loading #{girbrc}"
+        end
+
+        load girbrc.to_s
+        true
+      rescue SyntaxError, LoadError, StandardError => e
+        warn "[girb] Error loading #{girbrc}: #{e.message}"
+        false
+      end
+    end
+  end
+end

data/lib/girb/providers/base.rb

@@ -24,8 +24,9 @@ module Girb
       #   Each message has :role (:user, :assistant, :tool_call, :tool_result) and :content
       # @param system_prompt [String] System prompt
       # @param tools [Array<Hash>] Tool definitions in normalized format
+      # @param binding [Binding] Optional binding for tool execution (used by some providers)
       # @return [Response] Response object with text and/or function_calls
-      def chat(messages:, system_prompt:, tools:)
+      def chat(messages:, system_prompt:, tools:, binding: nil)
         raise NotImplementedError, "#{self.class}#chat must be implemented"
       end
 

data/lib/girb/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Girb
+  class Railtie < Rails::Railtie
+    console do
+      require "irb" unless defined?(IRB)
+      Girb::GirbrcLoader.load_girbrc(Rails.root)
+      Girb.setup!
+    end
+  end
+end

data/lib/girb/tools/environment_tools.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Girb
+  module Tools
+    # General tool for getting current directory - always available
+    class GetCurrentDirectory < Base
+      class << self
+        def description
+          "Get the current working directory (pwd). Use this when user asks about current directory or project location."
+        end
+
+        def parameters
+          {
+            type: "object",
+            properties: {},
+            required: []
+          }
+        end
+      end
+
+      def execute(binding)
+        {
+          current_directory: Dir.pwd,
+          home_directory: Dir.home
+        }
+      end
+    end
+  end
+end

data/lib/girb/tools/rails_tools.rb

@@ -4,6 +4,64 @@ require_relative "base"
 
 module Girb
   module Tools
+    class RailsProjectInfo < Base
+      class << self
+        def available?
+          defined?(Rails)
+        end
+
+        def description
+          "Get Rails project information: current directory (Rails.root), environment, Ruby/Rails versions, database config, and list of all defined models. Use this to find project path or list models."
+        end
+
+        def parameters
+          {
+            type: "object",
+            properties: {},
+            required: []
+          }
+        end
+      end
+
+      def execute(binding)
+        info = {
+          root: Rails.root.to_s,
+          environment: Rails.env,
+          ruby_version: RUBY_VERSION
+        }
+
+        # Rails version
+        info[:rails_version] = Rails.version if Rails.respond_to?(:version)
+
+        # Database info
+        if defined?(ActiveRecord::Base)
+          begin
+            config = ActiveRecord::Base.connection_db_config
+            info[:database] = {
+              adapter: config.adapter,
+              database: config.database
+            }
+          rescue StandardError
+            # DB not connected
+          end
+        end
+
+        # Defined models
+        if defined?(ActiveRecord::Base)
+          begin
+            Rails.application.eager_load! unless Rails.application.config.eager_load
+            info[:models] = ActiveRecord::Base.descendants.map(&:name).sort
+          rescue StandardError
+            # Unable to load models
+          end
+        end
+
+        info
+      rescue StandardError => e
+        { error: "#{e.class}: #{e.message}" }
+      end
+    end
+
     class RailsModelInfo < Base
       class << self
         def available?

data/lib/girb/tools.rb

@@ -8,19 +8,21 @@ require_relative "tools/evaluate_code"
 require_relative "tools/read_file"
 require_relative "tools/find_file"
 require_relative "tools/session_history_tool"
+require_relative "tools/environment_tools"
 
 module Girb
   module Tools
-    CORE_TOOLS = [InspectObject, GetSource, ListMethods, EvaluateCode, ReadFile, FindFile, SessionHistoryTool].freeze
+    CORE_TOOLS = [InspectObject, GetSource, ListMethods, EvaluateCode, ReadFile, FindFile, SessionHistoryTool, GetCurrentDirectory].freeze
 
     class << self
       def available_tools
         tools = CORE_TOOLS.dup
 
         # Rails tools are loaded conditionally
-        if defined?(ActiveRecord::Base)
+        if defined?(Rails)
           require_relative "tools/rails_tools"
-          tools << RailsModelInfo
+          tools << RailsProjectInfo
+          tools << RailsModelInfo if defined?(ActiveRecord::Base)
         end
 
         tools.select { |t| !t.respond_to?(:available?) || t.available? }

data/lib/girb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Girb
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/girb.rb

@@ -2,6 +2,7 @@
 
 require_relative "girb/version"
 require_relative "girb/configuration"
+require_relative "girb/girbrc_loader"
 require_relative "girb/providers/base"
 require_relative "girb/exception_capture"
 require_relative "girb/context_builder"
@@ -37,6 +38,9 @@ if defined?(IRB)
   Girb.setup!
 end
 
+# Rails がロードされていたら Railtie を組み込む
+require_relative "girb/railtie" if defined?(Rails::Railtie)
+
 # binding.girb サポート
 class Binding
   def girb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: girb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - rira100000000
@@ -88,12 +88,15 @@ files:
 - lib/girb/context_builder.rb
 - lib/girb/conversation_history.rb
 - lib/girb/exception_capture.rb
+- lib/girb/girbrc_loader.rb
 - lib/girb/irb_integration.rb
 - lib/girb/prompt_builder.rb
 - lib/girb/providers/base.rb
+- lib/girb/railtie.rb
 - lib/girb/session_history.rb
 - lib/girb/tools.rb
 - lib/girb/tools/base.rb
+- lib/girb/tools/environment_tools.rb
 - lib/girb/tools/evaluate_code.rb
 - lib/girb/tools/find_file.rb
 - lib/girb/tools/get_source.rb