summaryrefslogtreecommitdiff
path: root/.config/zsh/oh-my-zsh/plugins/gem/README.md
diff options
context:
space:
mode:
authorPedro Pereira <pedro.hr.pereira@proton.me>2026-10-16 15:19:13 -0300
committerPedro Pereira <pedro.hr.pereira@proton.me>2026-10-16 15:19:13 -0300
commit1eb69e9a795cc19450178c07d8d382622bc7ad70 (patch)
treeb6bc60605044fe929986f31b3b6bf4fee9b56e14 /.config/zsh/oh-my-zsh/plugins/gem/README.md
first commit
Diffstat (limited to '.config/zsh/oh-my-zsh/plugins/gem/README.md')
-rw-r--r--.config/zsh/oh-my-zsh/plugins/gem/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/.config/zsh/oh-my-zsh/plugins/gem/README.md b/.config/zsh/oh-my-zsh/plugins/gem/README.md
new file mode 100644
index 0000000..decd87b
--- /dev/null
+++ b/.config/zsh/oh-my-zsh/plugins/gem/README.md
@@ -0,0 +1,17 @@
+# Gem plugin
+
+This plugin adds completions and aliases for [Gem](https://rubygems.org/). The completions include the common `gem` subcommands as well as the installed gems in the current directory.
+
+To use it, add `gem` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... gem)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+|----------------------|-------------------------------|--------------------------------------------|
+| gemb | `gem build *.gemspec` | Build a gem from a gemspec |
+| gemp | `gem push *.gem` | Push a gem up to the gem server |
+| gemy [gem] [version] | `gem yank [gem] -v [version]` | Remove a pushed gem version from the index |