summaryrefslogtreecommitdiff
path: root/plugins/rails/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/rails/README.md')
-rw-r--r--plugins/rails/README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/plugins/rails/README.md b/plugins/rails/README.md
index 0a6c68c75..3eee12fbd 100644
--- a/plugins/rails/README.md
+++ b/plugins/rails/README.md
@@ -1,6 +1,7 @@
# Rails
-This plugin adds completion for [Ruby On Rails Framework](https://rubyonrails.org/) and [Rake](https://ruby.github.io/rake/) commands, as well as some aliases for logs and environment variables.
+This plugin adds completion for [Ruby On Rails Framework](https://rubyonrails.org/) and
+[Rake](https://ruby.github.io/rake/) commands, as well as some aliases for logs and environment variables.
To use it, add `rails` to the plugins array in your zshrc file:
@@ -67,7 +68,9 @@ plugins=(... rails)
These are global aliases. Use in combination with a command or just run them
separately. For example: `REP rake db:migrate` will migrate the production db.
-### Legacy rake aliases
+## Legacy
+
+### Rake aliases
The following commands are run [using `rails` instead of `rake` since Rails v5][1], but are preserved under the
prefix `rk` for backwards compatibility.
@@ -93,7 +96,7 @@ prefix `rk` for backwards compatibility.
| `rksts` | `rake stats` | Print code statistics |
| `rkt` | `rake test` | Run Rails tests |
-### Legacy stuff
+### Other
| Alias | Command |
| ------- | ---------------------------------- |
@@ -105,3 +108,5 @@ prefix `rk` for backwards compatibility.
| `sr` | `ruby script/runner` |
| `ssp` | `ruby script/spec` |
| `sstat` | `thin --stats "/thin/stats" start` |
+
+- `remote_console <server> <directory>`: runs `ruby script/console production` on a remote server.