ruby-shell 3.0.0 → 3.2.0

data/README.md

@@ -33,7 +33,34 @@ Or simply `gem install ruby-shell`.
 * All colors are themeable in .rshrc (see github link for possibilities)
 * Copy current command line to primary selection (paste w/middle button) with `Ctrl-y`
 
-## NEW in v3.0.0 - Major Feature Release ⭐⭐⭐
+## NEW in v3.2.0 - Plugin System & Productivity ⭐⭐⭐
+* **Plugin Architecture**: Extensible plugin system with lifecycle hooks and extension points
+* **Lifecycle Hooks**: on_startup, on_command_before, on_command_after, on_prompt
+* **Extension Points**: add_completions (TAB completion), add_commands (custom commands)
+* **Plugin Management**: `:plugins` list/reload/enable/disable/info commands
+* **Auto-loading**: Plugins in `~/.rsh/plugins/` load automatically on startup
+* **Safe Execution**: Isolated plugin execution with error handling, no shell crashes
+* **Example Plugins**: git_prompt (branch in prompt), command_logger (audit log), kubectl_completion (k8s shortcuts)
+* **Auto-correct Typos**: `:config "auto_correct", "on"` with user confirmation (Y/n) before applying
+* **Command Timing Alerts**: `:config "slow_command_threshold", "5"` warns on commands > 5 seconds
+* **Inline Calculator**: `:calc 2 + 2`, `:calc "Math::PI"` - full Ruby Math library support
+* **Enhanced History**: `!!` (last), `!-2` (2nd to last), `!5:7` (chain commands 5-7)
+* **Stats Visualization**: `:stats --graph` for colorful ASCII bar charts with intensity colors
+* **Documentation**: Complete PLUGIN_GUIDE.md with API reference and examples
+
+## v3.1.0 - Quick Wins & Polish ⭐
+* **Multiple Named Sessions**: Save/load different sessions - `:save_session "project"`, `:load_session "project"`
+* **Stats Export**: Export analytics to CSV/JSON - `:stats --csv` or `:stats --json`
+* **Session Auto-save**: Set `@session_autosave = 300` in .rshrc for automatic 5-minute saves
+* **Bookmark Import/Export**: Share bookmarks - `:bm --export bookmarks.json`, `:bm --import bookmarks.json`
+* **Bookmark Statistics**: See usage patterns - `:bm --stats` shows tag distribution and analytics
+* **Color Themes**: 6 preset themes - `:theme solarized|dracula|gruvbox|nord|monokai|default`
+* **Config Management**: `:config` shows/sets history_dedup, session_autosave, completion settings
+* **Environment Variables**: `:env` lists/sets/exports environment variables
+* **Bookmark TAB Completion**: Bookmarks appear in TAB completion alongside commands
+* **List Sessions**: `:list_sessions` shows all saved sessions with timestamps and paths
+
+## v3.0.0 - Major Feature Release ⭐⭐⭐
 * **Persistent Ruby Functions**: defun functions now save to .rshrc and persist across sessions
 * **Smart Command Suggestions**: Typo detection with "Did you mean...?" suggestions using Levenshtein distance
 * **Command Analytics**: New `:stats` command shows usage statistics, performance metrics, and most-used commands
@@ -94,8 +121,10 @@ Special commands:
 * `:bm "name"` or `:bookmark "name"` bookmark current directory, `:bm "name path #tags"` with tags (NEW in v3.0)
 * `:bm` lists all bookmarks, just type bookmark name to jump (e.g., `work`) (NEW in v3.0)
 * `:bm "-name"` delete bookmark, `:bm "?tag"` search by tag (NEW in v3.0)
-* `:save_session` saves current shell session (pwd, history, bookmarks, defuns) (NEW in v3.0)
-* `:load_session` restores previously saved session (NEW in v3.0)
+* `:save_session "name"` saves named session, `:load_session "name"` loads session (NEW in v3.0)
+* `:list_sessions` shows all saved sessions, `:rmsession "name"` or `:rmsession "*"` deletes (NEW in v3.1)
+* `:theme "name"` applies color scheme, `:config` manages settings, `:env` manages environment (NEW in v3.1)
+* `:plugins` lists plugins, `:plugins "disable", "name"` disables, `:plugins "reload"` reloads (NEW in v3.2)
 * `:info` shows introduction and feature overview
 * `:version` Shows the rsh version number and the last published gem file version
 * `:help` will display a compact command reference in two columns
@@ -125,12 +154,19 @@ Add to your `.rshrc`:
 While you `cd` around to different directories, you can see the last 10 directories visited via the command `:dirs` or the convenient shortcut `#`. Entering the number in the list (like `6` and ENTER) will jump you to that directory. Entering `-` will jump you back to the previous dir (equivalent of `1`. Entering `~` will get you to your home dir. If you want to bookmark a special directory, you can do that via a general nick like this: `:gnick "x = /path/to/a/dir/"` - this would bookmark the directory to the single letter `x`.
 
 ## Nicks
-Add command nicks (aliases) with `:nick "some_nick = some_command"`, e.g. `:nick "ls = ls --color"`. Add general nicks that will substitute anything on a command line (not just commands) like this `:gnick "some_gnick = some_command"`, e.g. `:gnick "x = /home/user/somewhere"`. List (g)nicks with `:nick?`. Remove a nick with `:nick "-some_command"`, e.g. `:nick "-ls"` to remove an `ls` nick. Same for gnicks.
+Add command nicks (aliases) with `:nick "some_nick = some_command"`, e.g. `:nick "ls = ls --color"`. Add general nicks that will substitute anything on a command line (not just commands) like this `:gnick "some_gnick = some_command"`, e.g. `:gnick "x = /home/user/somewhere"`. List nicks with `:nick`, list gnicks with `:gnick`. Remove a nick with `:nick "-some_command"`, e.g. `:nick "-ls"` to remove an `ls` nick. Same for gnicks.
 
 ## Tab completion
-You can tab complete almost anything. Hitting `TAB` will try to complete in this priority: nicks, gnicks, commands, dirs/files. Hitting `TAB`after a `-` will list the command switches for the preceding command with a short explanation (from the command's --help), like this `ls -`(`TAB`) will list all the switches/options for the `ls` command. You can add to (or subtract from) the search criteria while selecting possible matches - hit any letter to specify the search, while backspace removes a letter from the search criteria. 
+You can tab complete almost anything. Hitting `TAB` will try to complete in this priority: nicks, gnicks, commands, dirs/files. Special completions:
+- `ls -<TAB>` lists command switches from --help with descriptions
+- `:st<TAB>` completes colon commands (:stats, etc.)
+- `$HO<TAB>` completes environment variables ($HOME, etc.)
+- `git <TAB>` shows git subcommands (add, commit, push, etc.)
+- `--format=<TAB>` completes option values (json, yaml, xml, etc.)
 
-Hitting Shift-TAB will do a similar search through the command history - but with a general match of the search criteria (not only matching at the start).
+You can add to (or subtract from) the search criteria while selecting matches - hit any letter to refine the search, backspace removes a letter from the criteria.
+
+Hitting Shift-TAB will search through the command history with fuzzy matching.
 
 ## Open files
 If you press `ENTER` after writing or tab-completing to a file, rsh will try to open the file in the user's EDITOR of choice (if it is a valid text file) or use `xdg-open` to open the file using the correct program. If you, for some reason want to use `run-mailcap` instead of `xdg-open` as the file opener, simply add `@runmailcap = true` to your `.rshrc`.
@@ -191,6 +227,52 @@ Ruby functions have access to:
 - JSON/XML parsing
 - And everything else Ruby can do!
 
+## Plugin System (v3.2.0+)
+
+rsh supports a powerful plugin system for extending functionality. Plugins are Ruby classes placed in `~/.rsh/plugins/` that can:
+
+- Add custom commands
+- Add TAB completions
+- Hook into command execution (before/after)
+- Modify the prompt
+- Access rsh internals (history, bookmarks, etc.)
+
+**Quick Start:**
+```ruby
+# Create ~/.rsh/plugins/hello.rb
+class HelloPlugin
+  def initialize(rsh_context)
+    @rsh = rsh_context
+  end
+
+  def add_commands
+    {
+      "hello" => lambda { |*args| "Hello, #{args[0] || 'World'}!" }
+    }
+  end
+end
+```
+
+Then in rsh: `hello Geir` outputs `Hello, Geir!`
+
+**Plugin Management:**
+```bash
+:plugins                        # List all loaded plugins
+:plugins "disable", "git_prompt"  # Disable a plugin
+:plugins "enable", "git_prompt"   # Enable a plugin
+:plugins "reload"                 # Reload all plugins
+:plugins "info", "plugin_name"    # Show plugin details
+```
+
+**Included Example Plugins:**
+- **git_prompt** - Shows current git branch in prompt
+- **command_logger** - Logs all commands with timestamps (`show_log` to view)
+- **kubectl_completion** - Kubernetes shortcuts and completions (k, kns, kctx)
+
+**See PLUGIN_GUIDE.md for complete development documentation.**
+
+---
+
 ## Integrations
 rsh is integrated with the [rtfm file manager](https://github.com/isene/RTFM), with [fzf](https://github.com/junegunn/fzf) and with the programming language [XRPN](https://github.com/isene/xrpn). 
 
@@ -215,6 +297,7 @@ Variable        | Description
 `@c_path`       | Color for valid path
 `@c_switch`     | Color for command switches/options
 `@c_bookmark`   | Color for bookmarks (NEW in v3.0)
+`@c_colon`      | Color for colon commands (NEW in v3.1)
 `@c_tabselect`  | Color for selected tabcompleted item
 `@c_taboption`  | Color for unselected tabcompleted item
 `@c_stamp`      | Color for time stamp/command