]> src.twobees.de Git - dotfiles.git/blob - stow/oh-my-zsh/.oh-my-zsh/plugins/rake/README.md
initial
[dotfiles.git] / stow / oh-my-zsh / .oh-my-zsh / plugins / rake / README.md
1 # Rake plugin
2
3 This plugin adds support for [rake](https://ruby.github.io/rake/), the Ruby
4 build tool or Ruby Make.
5
6 To use it, add `rake` to the plugins array in your zshrc file:
7
8 ```zsh
9 plugins=(... rake)
10 ```
11
12 ## Aliases
13
14 The plugin aliases the rake command so you can pass arguments when invoking rake tasks
15 without having to escape the brackets, i.e., you can run
16
17 ```sh
18 rake namespace:task['argument']
19 ```
20
21 instead of having to do
22
23 ```sh
24 rake namespace:task\['argument'\]
25 ```
26
27 | Alias      | Command                        | Description                                   |
28 | ---------- | ------------------------------ | --------------------------------------------- |
29 | `rake`     | `noglob rake`                  | Allows unescaped square brackets              |
30 | `bin/rake` | `noglob bin/rake`              | Same as above but using rake binstub          |
31 | `brake`    | `noglob bundle exec rake`      | Same as above but call rake using bundler     |
32 | `srake`    | `noglob sudo rake`             | Same as rake but using sudo                   |
33 | `sbrake`   | `noglob sudo bundle exec rake` | Same as above but using both sudo and bundler |
34
35 ## Jim Weirich
36
37 The plugin also aliases `rake` to [`jimweirich`](https://github.com/jimweirich), author of Rake
38 and big time contributor to the Ruby open source community. He passed away in 2014:
39
40 > Thank you Jim for everything you contributed to the Ruby and open source community
41 > over the years. We will miss you dearly. — [**@robbyrussell**](https://github.com/ohmyzsh/ohmyzsh/commit/598a9c6f990756386517d66b6bcf77e53791e905)