summaryrefslogtreecommitdiff
path: root/plugins/ruby
diff options
context:
space:
mode:
authorLuiz Guilherme Fonseca Rosa <luizguilhermefr@gmail.com>2018-10-08 10:20:10 -0300
committerGitHub <noreply@github.com>2018-10-08 10:20:10 -0300
commited401bc55af2e5b08d1ff903111a65838473ad9d (patch)
tree621f7623dedf79dd9117a20e84c0997eac8217e3 /plugins/ruby
parentc2113d7cc67e2865a4692918198fba27e8360fe5 (diff)
parent7b29684a3087c881f240ebb74bd387c69f0ffcc6 (diff)
downloadzsh-ed401bc55af2e5b08d1ff903111a65838473ad9d.tar.gz
zsh-ed401bc55af2e5b08d1ff903111a65838473ad9d.tar.bz2
zsh-ed401bc55af2e5b08d1ff903111a65838473ad9d.zip
Merge branch 'master' into master
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 |