diff options
| author | MasterOfTheTiger <ted.jameson@pm.me> | 2018-10-04 03:48:29 -0700 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2018-10-04 12:48:29 +0200 |
| commit | c64964469559cea37a19cdfe847a95f41562993f (patch) | |
| tree | 6e6840f0728f69cfd41969ddeb46f83ffeefcf05 /plugins/ruby | |
| parent | 9d57a90b41b1d8c3d80de8a8b0ac23154231388c (diff) | |
| download | zsh-c64964469559cea37a19cdfe847a95f41562993f.tar.gz zsh-c64964469559cea37a19cdfe847a95f41562993f.tar.bz2 zsh-c64964469559cea37a19cdfe847a95f41562993f.zip | |
ruby: add README (#7212)
Diffstat (limited to 'plugins/ruby')
| -rw-r--r-- | plugins/ruby/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/ruby/README.md b/plugins/ruby/README.md new file mode 100644 index 000000000..ad2755bbf --- /dev/null +++ b/plugins/ruby/README.md @@ -0,0 +1,20 @@ +# Ruby plugin + +This plugin adds aliases for common commands used in dealing with [Ruby](https://www.ruby-lang.org/en/) and [gem packages](https://rubygems.org/). + +To use it, add `ruby` to the plugins array in your zshrc file: + +```zsh +plugins=(... ruby) +``` + +## Aliases + +| Alias | Command | Description | +|-------|----------------------------------------|------------------------------------------------------| +| rb | `ruby` | The Ruby command | +| sgem | `sudo gem` | Run sudo gem on the system ruby, not the active ruby | +| rfind | `find . -name "*.rb" \| xargs grep -n` | Find ruby file | +| gin | `gem install` | Install a gem into the local repository | +| gun | `gem uninstall` | Uninstall gems from the local repository | +| gli | `gem list` | Display gems installed locally | |