summaryrefslogtreecommitdiff
path: root/plugins/ruby
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2018-10-09 14:46:47 -0400
committerTuowen Zhao <ztuowen@gmail.com>2018-10-09 14:46:47 -0400
commit075160b86c64045e661209ad7906559068b44104 (patch)
treea910a6eef6163d39859395bb0b416b2b184db9ac /plugins/ruby
parent5ece6ef2f07c58672a9c965dbbbb62a42386fb2d (diff)
parent3c9942c4884089b290ef750468b29419ca0de271 (diff)
downloadzsh-075160b86c64045e661209ad7906559068b44104.tar.gz
zsh-075160b86c64045e661209ad7906559068b44104.tar.bz2
zsh-075160b86c64045e661209ad7906559068b44104.zip
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/ruby')
-rw-r--r--plugins/ruby/README.md20
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 |