]> src.twobees.de Git - dotfiles.git/blob - stow/oh-my-zsh/.oh-my-zsh/plugins/ruby/README.md
59d839c5cd56783949258a635b7b12c75feeebd0
[dotfiles.git] / stow / oh-my-zsh / .oh-my-zsh / plugins / ruby / README.md
1 # Ruby plugin
2
3 This plugin adds aliases for common commands used in dealing with [Ruby](https://www.ruby-lang.org/en/) and [gem packages](https://rubygems.org/).
4
5 To use it, add `ruby` to the plugins array in your zshrc file:
6
7 ```zsh
8 plugins=(... ruby)
9 ```
10
11 ## Aliases
12
13 | Alias   | Command                                | Description                                          |
14 | ------- | -------------------------------------- | ---------------------------------------------------- |
15 | rb      | `ruby`                                 | The Ruby command                                     |
16 | sgem    | `sudo gem`                             | Run sudo gem on the system ruby, not the active ruby |
17 | rfind   | `find . -name "*.rb" \| xargs grep -n` | Find ruby file                                       |
18 | rrun    | `ruby -e`                              | Execute some code: E.g: `rrun "puts 'Hello world!'"` |
19 | rserver | `ruby -e httpd . -p 8080`              | Start HTTP Webrick serving local directory/files     |
20 | gein    | `gem install`                          | Install a gem into the local repository              |
21 | geun    | `gem uninstall`                        | Uninstall gems from the local repository             |
22 | geli    | `gem list`                             | Display gems installed locally                       |
23 | gei     | `gem info`                             | Show information for the given gem                   |
24 | geiall  | `gem info --all`                       | Display all gem versions                             |
25 | geca    | `gem cert --add`                       | Add a trusted certificate                            |
26 | gecr    | `gem cert --remove`                    | Remove a trusted certificate                         |
27 | gecb    | `gem cert --build`                     | Build private key and self-signed certificate        |
28 | geclup  | `gem cleanup -n`                       | Do not uninstall gem                                 |
29 | gegi    | `gem generate_index`                   | Generate index file for gem server                   |
30 | geh     | `gem help`                             | Provide additional help                              |
31 | gel     | `gem lock`                             | Generate a lockdown list of gems                     |
32 | geo     | `gem open`                             | Open gem source in default editor                    |
33 | geoe    | `gem open -e`                          | Open gem sources in preferred editor                 |