ruby-shell 3.1.0 → 3.3.0

data/README.md

@@ -33,7 +33,33 @@ 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.1.0 - Quick Wins & Polish ⭐
+## NEW in v3.3.0 - Quote-less Syntax, Parametrized Nicks & More ⭐⭐⭐
+* **No More Quotes**: Simplified syntax - `:nick la = ls -la` instead of `:nick "la = ls -la"`
+* **Parametrized Nicks**: `:nick gp = git push origin {{branch}}` then use `gp branch=main`
+* **Ctrl-G Multi-line Edit**: Press Ctrl-G to edit command in $EDITOR for complex scripts
+* **Custom Validation Rules**: `:validate rm -rf / = block` prevents dangerous commands
+* **Shell Script Support**: for/while/if loops work with full bash syntax
+* **Cleaner Commands**: `:config auto_correct on`, `:bm work /tmp #dev`, `:theme dracula`
+* **Simplified Architecture**: Removed :template (merged into :nick for simplicity)
+* **Backward Compatible**: Old quote syntax still works for existing .rshrc files
+* **Better UX**: Less typing, more powerful, feels more natural
+
+## 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
@@ -94,20 +120,23 @@ Special functions/integrations:
 * Use `:` followed by a Ruby expression to access the whole world of Ruby
 
 Special commands:
-* `:nick 'll = ls -l'` to make a command alias (ll) point to a command (ls -l)
-* `:gnick 'h = /home/me'` to make a general alias (h) point to something (/home/me)
-* `:nick` lists all command nicks, `:gnick` lists general nicks (NEW in v3.0)
-* `:nick '-name'` delete a command nick, `:gnick '-name'` delete a general nick (NEW in v3.0)
+* `:nick ll = ls -l` to make a command alias (ll) point to a command (ls -l)
+* `:gnick h = /home/me` to make a general alias (h) point to something (/home/me)
+* `:nick` lists all command nicks, `:gnick` lists general nicks
+* `:nick -name` delete a command nick, `:gnick -name` delete a general nick
 * `:history` will list the command history, while `:rmhistory` will delete the history
 * `:jobs` will list background jobs, `:fg [job_id]` brings jobs to foreground, `:bg [job_id]` resumes stopped jobs
-* `:defun 'func(args) = code'` defines Ruby functions callable as shell commands (now persistent!)
-* `:defun?` lists all user-defined functions, `:defun '-func'` removes functions
-* `:stats` shows command execution statistics and analytics (NEW in v3.0)
-* `: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 "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)
+* `:defun func(args) = code` defines Ruby functions callable as shell commands (persistent!)
+* `:defun?` lists all user-defined functions, `:defun -func` removes functions
+* `:stats` shows command execution statistics, `:stats --graph` for visual charts, `:stats --clear` to reset
+* `:bm name` or `:bookmark name` bookmark current directory, `:bm name path #tags` with tags
+* `:bm` lists all bookmarks, just type bookmark name to jump (e.g., `work`)
+* `:bm -name` delete bookmark, `:bm ?tag` search by tag, `:bm --stats` show statistics
+* `:save_session name` saves named session, `:load_session name` loads session
+* `:list_sessions` shows all saved sessions, `:rmsession name` or `:rmsession *` deletes
+* `:theme name` applies color scheme, `:config` manages settings, `:env` manages environment
+* `:plugins` lists plugins, `:plugins disable name` disables, `:plugins reload` reloads
+* `:calc expression` inline calculator with Ruby Math library
 * `: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
@@ -134,10 +163,82 @@ Add to your `.rshrc`:
 ```
 
 ## Moving around
-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`.
+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 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.
+
+Nicks are powerful aliases that can be simple command shortcuts or complex parametrized templates.
+
+### Simple Nicks
+```bash
+:nick ls = ls --color        # Simple alias
+:nick la = ls -la            # Another shortcut
+:nick                        # List all nicks
+:nick -la                    # Delete a nick
+```
+
+### Parametrized Nicks (NEW in v3.3!)
+Create templates with `{{placeholder}}` parameters:
+
+```bash
+# Git shortcuts with branch parameter
+:nick gp = git push origin {{branch}}
+gp branch=main               # Executes: git push origin main
+gp branch=develop            # Executes: git push origin develop
+
+# Deployment with multiple parameters
+:nick deploy = ssh {{user}}@{{host}} 'cd {{path}} && git pull'
+deploy user=admin host=prod path=/var/www
+# Executes: ssh admin@prod 'cd /var/www && git pull'
+
+# Backup with source and destination
+:nick backup = rsync -av {{src}} {{dest}}
+backup src=/data dest=/backup
+# Executes: rsync -av /data /backup
+```
+
+**How it works:**
+- Define nick with `{{param}}` placeholders
+- Use with `key=value` syntax
+- Parameters auto-expand and get stripped from final command
+- Works with any number of parameters
+
+### General Nicks (gnicks)
+Substitute anywhere on command line (not just commands):
+```bash
+:gnick h = /home/user        # Directory shortcut
+:gnick                       # List all gnicks
+:gnick -h                    # Delete a gnick
+```
+
+## Multi-line Command Editing (v3.3.0+)
+
+Press **Ctrl-G** to edit the current command in your $EDITOR:
+
+```bash
+# Start typing a complex command
+for i in {1..10}
+
+# Press Ctrl-G
+# Your editor opens with the command
+# Add more lines:
+for i in {1..10}
+  echo "Processing: $i"
+  sleep 1
+done
+
+# Save and quit
+# Command appears on command line (converted to single-line with ;)
+# Press ENTER to execute
+```
+
+**Perfect for:**
+- Complex shell scripts
+- Long commands with many options
+- Multi-line constructs (for, while, if)
+- Commands you want to review/edit carefully
+
+---
 
 ## Tab completion
 You can tab complete almost anything. Hitting `TAB` will try to complete in this priority: nicks, gnicks, commands, dirs/files. Special completions:
@@ -210,6 +311,89 @@ Ruby functions have access to:
 - JSON/XML parsing
 - And everything else Ruby can do!
 
+## Custom Validation Rules (v3.3.0+)
+
+Create safety rules to block, confirm, warn, or log specific command patterns:
+
+```bash
+# Block dangerous commands completely
+:validate rm -rf / = block
+
+# Require confirmation for risky operations
+:validate git push --force = confirm
+:validate DROP TABLE = confirm
+
+# Show warnings but allow execution
+:validate sudo = warn
+:validate chmod 777 = warn
+
+# Log specific commands for audit trail
+:validate npm install = log
+# Logs to ~/.rsh_validation.log
+
+# List all rules
+:validate
+
+# Delete rule by index
+:validate -1
+```
+
+**Actions:**
+- `block` - Prevent command execution completely
+- `confirm` - Ask for confirmation (y/N)
+- `warn` - Show warning but allow
+- `log` - Silently log to ~/.rsh_validation.log
+
+**Pattern matching:** Uses regex, so you can match complex patterns.
+
+---
+
+## 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).