beniya 0.6.3 → 0.8.0

data/README.md

@@ -12,6 +12,8 @@ beniyaは、Yaziにインスパイアされたターミナル上で動作する
 
 - **軽量でシンプル**: Rubyで書かれた軽量なファイルマネージャー
 - **直感的な操作**: Vimライクなキーバインド
+- **プラグインシステム**: 拡張可能なプラグインアーキテクチャ
+- **コマンドモード**: Tab補完とフローティングウィンドウを備えた強力なコマンドシステム
 - **ファイルプレビュー**: テキストファイルの内容をその場で確認
 - **ファイル選択・操作**: 複数ファイルの選択、移動、コピー、削除が可能
 - **ベースディレクトリ操作**: 起動ディレクトリへの一括ファイル移動・コピー
@@ -117,6 +119,15 @@ beniya --help           # ヘルプメッセージを表示
 | ---- | ---------------------------------- |
 | `z`  | zoxide履歴からディレクトリを選択移動 |
 
+#### コマンドモード
+
+| キー   | 機能                                     |
+| ------ | ---------------------------------------- |
+| `:`    | コマンドモードを起動                     |
+| `Tab`  | コマンド補完（コマンドモード中）         |
+| `Enter`| コマンドを実行（コマンドモード中）       |
+| `ESC`  | コマンドモードをキャンセル（コマンドモード中） |
+
 #### システム操作
 
 | キー | 機能         |
@@ -271,6 +282,46 @@ apt install zoxide
 - zoxideが無効な場合は適切なメッセージが表示されます
 - 履歴が空の場合も適切にハンドリングされます
 
+### コマンドモードの詳細
+
+#### コマンドモードの起動 (`:`)
+
+- `:`キーを押してコマンドモードを起動
+- 画面最下部にコマンド入力欄が表示される
+- プラグインが提供するコマンドを実行できる
+
+#### Tab補完機能
+
+- **インテリジェントな補完**: コマンド名の一部を入力して`Tab`キーを押すと自動補完
+- **複数候補の処理**: 複数のコマンドが一致する場合は共通プレフィックスまで補完
+- **単一候補の自動完成**: 一つだけマッチする場合は完全に補完される
+- **リアルタイム更新**: 入力内容に応じて候補が動的に変化
+
+#### フローティングウィンドウでの結果表示
+
+- **視覚的フィードバック**: コマンド実行結果をモダンなフローティングウィンドウで表示
+- **色分けされた結果**:
+  - **緑色のボーダー**: コマンドが正常に実行された場合
+  - **赤色のボーダー**: エラーまたは警告が発生した場合
+- **中央配置**: 画面中央に自動的に配置され視認性が高い
+- **自動サイズ調整**: 結果の内容に応じてウィンドウサイズが自動調整
+- **簡単に閉じる**: 任意のキーを押すとウィンドウを閉じて通常操作に戻る
+
+#### 使用例
+
+```
+1. : → コマンドモードを起動
+2. "he" → コマンド名の一部を入力
+3. Tab → 補完（"hello", "help", "health"などが候補）
+4. Enter → コマンドを実行
+5. フローティングウィンドウで結果を確認
+6. 任意のキーを押してウィンドウを閉じる
+```
+
+#### 利用可能なコマンド
+
+コマンドはプラグインによって提供されます。プラグインシステムの詳細については後述の「プラグインシステム」セクションを参照してください。
+
 ### 必要な外部ツール
 
 検索機能・履歴機能を使用するには、以下のツールが必要です:
@@ -351,6 +402,189 @@ COLORS = {
 - `selected`: 選択中の項目の色
 - `preview`: プレビューパネルの色
 
+## プラグインシステム
+
+beniyaは拡張可能なプラグインシステムを備えており、独自の機能を簡単に追加できます。
+
+### プラグインの配置場所
+
+#### 1. 本体同梱プラグイン
+```
+lib/beniya/plugins/*.rb
+```
+beniyaに標準で含まれるプラグイン。外部gem依存なしの基本機能を提供。
+
+#### 2. ユーザープラグイン
+```
+~/.beniya/plugins/*.rb
+```
+ユーザーが自由に追加できるプラグイン。GitHub GistやrawURLから取得可能。
+
+### プラグインの作成方法
+
+#### シンプルなプラグイン例
+
+```ruby
+# ~/.beniya/plugins/hello.rb
+module Beniya
+  module Plugins
+    class Hello < Plugin
+      def name
+        'Hello'
+      end
+
+      def description
+        'シンプルな挨拶プラグイン'
+      end
+
+      def commands
+        {
+          hello: method(:say_hello)
+        }
+      end
+
+      private
+
+      def say_hello
+        "Hello from beniya!"
+      end
+    end
+  end
+end
+```
+
+**プラグインの使い方:**
+
+1. beniyaを起動
+2. `:`キーでコマンドモードを起動
+3. `hello`と入力（または`he`と入力してTabキーで補完）
+4. Enterキーで実行
+5. フローティングウィンドウに"Hello from beniya!"が表示される
+
+#### 外部gemに依存するプラグイン例
+
+```ruby
+# ~/.beniya/plugins/ai_helper.rb
+module Beniya
+  module Plugins
+    class AiHelper < Plugin
+      requires 'anthropic'  # 依存gem宣言
+
+      def name
+        'AiHelper'
+      end
+
+      def description
+        'Claude APIを使ったAIアシスタント'
+      end
+
+      def commands
+        {
+          ai: method(:ask_ai)
+        }
+      end
+
+      def initialize
+        super  # 依存チェック実行
+        @client = Anthropic::Client.new(
+          api_key: ENV['ANTHROPIC_API_KEY']
+        )
+      end
+
+      private
+
+      def ask_ai
+        response = @client.messages.create(
+          model: "claude-3-5-sonnet-20241022",
+          max_tokens: 1024,
+          messages: [{role: "user", content: "Hello, Claude!"}]
+        )
+        response.content.first.text
+      end
+    end
+  end
+end
+```
+
+**プラグインの使い方:**
+
+1. 依存gemをインストール: `gem install anthropic`
+2. 環境変数を設定: `export ANTHROPIC_API_KEY=your_api_key`
+3. beniyaを起動
+4. `:`キーでコマンドモードを起動
+5. `ai`と入力してEnterキーで実行
+6. フローティングウィンドウにClaude APIからの応答が表示される
+
+### プラグインの管理
+
+#### プラグインの有効/無効設定
+
+`~/.beniya/config.yml`でプラグインの有効/無効を制御できます：
+
+```yaml
+plugins:
+  fileoperations:
+    enabled: true
+  ai_helper:
+    enabled: true
+  my_custom:
+    enabled: false
+```
+
+#### デフォルト動作
+
+- `config.yml`が存在しない → 全プラグイン有効
+- プラグインの設定がない → 有効とみなす
+- `enabled: false`が明示的に設定されている → 無効
+
+### プラグインの配布方法
+
+#### GitHub Gistで共有
+
+```bash
+# プラグイン作者
+1. GitHub Gistに.rbファイルをアップロード
+2. Raw URLをユーザーに共有
+
+# ユーザー
+$ mkdir -p ~/.beniya/plugins
+$ curl -o ~/.beniya/plugins/my_plugin.rb [RAW_URL]
+$ beniya
+✓ my_plugin 読み込み完了
+```
+
+#### GitHubリポジトリで共有
+
+```bash
+# プラグイン作者
+beniya-plugins/
+  ├── plugin1.rb
+  └── plugin2.rb
+
+# ユーザー
+$ curl -o ~/.beniya/plugins/plugin1.rb https://raw.githubusercontent.com/user/beniya-plugins/main/plugin1.rb
+```
+
+### プラグインの主要機能
+
+#### 必須メソッド
+
+- `name`: プラグイン名（必須）
+- `description`: プラグインの説明（オプション、デフォルト: ""）
+- `version`: プラグインのバージョン（オプション、デフォルト: "1.0.0"）
+- `commands`: コマンド定義（オプション、デフォルト: {}）
+
+#### 依存gem管理
+
+- `requires 'gem_name'`: 依存gemを宣言
+- 依存gemが不足している場合、警告を表示してプラグインを無効化
+- beniya本体は正常に起動継続
+
+#### 自動登録機能
+
+- `Plugin`クラスを継承すると自動的に`PluginManager`に登録
+- 複雑な登録処理は不要
+
 ## 開発
 
 ### 必要な環境

data/README_EN.md

@@ -12,6 +12,7 @@ beniya is a terminal-based file manager inspired by Yazi. It's implemented in Ru
 
 - **Lightweight & Simple**: A lightweight file manager written in Ruby
 - **Intuitive Operation**: Vim-like key bindings
+- **Plugin System**: Extensible plugin architecture
 - **File Preview**: View text file contents on the fly
 - **File Selection & Operations**: Select multiple files, move, copy, and delete
 - **Base Directory Operations**: Batch file operations to startup directory
@@ -352,6 +353,167 @@ COLORS = {
 - `selected`: Selected item color
 - `preview`: Preview panel color
 
+## Plugin System
+
+beniya features an extensible plugin system that allows you to easily add custom functionality.
+
+### Plugin Locations
+
+#### 1. Built-in Plugins
+```
+lib/beniya/plugins/*.rb
+```
+Plugins included with beniya by default. Provides basic functionality without external gem dependencies.
+
+#### 2. User Plugins
+```
+~/.beniya/plugins/*.rb
+```
+Plugins you can freely add. Can be obtained from GitHub Gist or raw URLs.
+
+### Creating Plugins
+
+#### Simple Plugin Example
+
+```ruby
+# ~/.beniya/plugins/hello.rb
+module Beniya
+  module Plugins
+    class Hello < Plugin
+      def name
+        'Hello'
+      end
+
+      def description
+        'Simple greeting plugin'
+      end
+
+      def commands
+        {
+          hello: method(:say_hello)
+        }
+      end
+
+      private
+
+      def say_hello
+        puts "Hello from beniya!"
+      end
+    end
+  end
+end
+```
+
+#### Plugin with External Gem Dependencies
+
+```ruby
+# ~/.beniya/plugins/ai_helper.rb
+module Beniya
+  module Plugins
+    class AiHelper < Plugin
+      requires 'anthropic'  # Declare gem dependency
+
+      def name
+        'AiHelper'
+      end
+
+      def description
+        'AI assistant using Claude API'
+      end
+
+      def commands
+        {
+          ai: method(:ask_ai)
+        }
+      end
+
+      def initialize
+        super  # Run dependency check
+        @client = Anthropic::Client.new(
+          api_key: ENV['ANTHROPIC_API_KEY']
+        )
+      end
+
+      private
+
+      def ask_ai(question)
+        # AI processing
+      end
+    end
+  end
+end
+```
+
+### Plugin Management
+
+#### Enable/Disable Plugins
+
+You can control plugin activation in `~/.beniya/config.yml`:
+
+```yaml
+plugins:
+  fileoperations:
+    enabled: true
+  ai_helper:
+    enabled: true
+  my_custom:
+    enabled: false
+```
+
+#### Default Behavior
+
+- No `config.yml` → All plugins enabled
+- Plugin not in config → Enabled by default
+- `enabled: false` explicitly set → Disabled
+
+### Plugin Distribution
+
+#### Share via GitHub Gist
+
+```bash
+# Plugin author
+1. Upload .rb file to GitHub Gist
+2. Share Raw URL with users
+
+# User
+$ mkdir -p ~/.beniya/plugins
+$ curl -o ~/.beniya/plugins/my_plugin.rb [RAW_URL]
+$ beniya
+✓ my_plugin loaded successfully
+```
+
+#### Share via GitHub Repository
+
+```bash
+# Plugin author
+beniya-plugins/
+  ├── plugin1.rb
+  └── plugin2.rb
+
+# User
+$ curl -o ~/.beniya/plugins/plugin1.rb https://raw.githubusercontent.com/user/beniya-plugins/main/plugin1.rb
+```
+
+### Plugin Key Features
+
+#### Required Methods
+
+- `name`: Plugin name (required)
+- `description`: Plugin description (optional, default: "")
+- `version`: Plugin version (optional, default: "1.0.0")
+- `commands`: Command definitions (optional, default: {})
+
+#### Dependency Management
+
+- `requires 'gem_name'`: Declare gem dependencies
+- If dependencies are missing, displays warning and disables plugin
+- beniya continues to start normally
+
+#### Auto-registration
+
+- Inheriting from `Plugin` class automatically registers with `PluginManager`
+- No complex registration process needed
+
 ## Development
 
 ### Requirements

data/bin/beniya

@@ -3,6 +3,9 @@
 
 require_relative '../lib/beniya'
 
+# プラグインを読み込む
+Beniya::PluginManager.load_all
+
 # コマンドライン引数の処理
 if ARGV.include?('--check-health') || ARGV.include?('-c')
   # ヘルスチェック実行