diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2019-10-24 17:57:01 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-24 17:57:01 +0200 |
| commit | cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9 (patch) | |
| tree | 2b07ec259bbd2b1a4919245669900a87fa87a03b /plugins/ruby/README.md | |
| parent | 225425fe091ca052997833279ccc08643818c24a (diff) | |
| parent | 40df67bc3b9b51caa24df5d220487043040d1f9a (diff) | |
| download | zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.gz zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.bz2 zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.zip | |
Merge branch 'master' into fabric_task_description
Diffstat (limited to 'plugins/ruby/README.md')
| -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 | |