Customization/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-30 17:50:07 +00:00
Code Releases Activity
ohmyzsh/plugins/rails/README.md

123 lines
8.2 KiB
Markdown
Raw Normal View History

rails: create README (#5841)
2019-04-15 17:29:49 +00:00
# Rails
chore(rails): fix comments and docs
2022-03-07 14:20:03 +00:00
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.
rails: create README (#5841)
2019-04-15 17:29:49 +00:00
To use it, add `rails` to the plugins array in your zshrc file:
```zsh
plugins=(... rails)
```
## List of Aliases
### Rails aliases
feat(rails)!: run old rake aliases with `rails` (#9601) BREAKING CHANGE: we've updated the aliases that run `rake` to use `rails` instead because that's how they are run since Rails v5. The old `rake` aliases can still be run by using the `rk` prefix (e.g. the `rake test` alias has been changed from `rt` to `rkt`). Closes #9601 Closes #9813 Fixes #10696 Co-authored-by: Vsevolod Voloshyn <seva.voloshin@gmail.com>
2021-01-15 19:23:15 +00:00
| Alias | Command | Description |
| ------- | -------------------------------- | ------------------------------------------------------ |
| `rc` | `rails console` | Interact with your Rails app from the CLI |
| `rcs` | `rails console --sandbox` | Test code in a sandbox, without changing any data |
| `rd` | `rails destroy` | Undo a generate operation |
| `rdb` | `rails dbconsole` | Interact with your db from the console |
| `rdc` | `rails db:create` | Create the database |
| `rdd` | `rails db:drop` | Delete the database |
| `rdm` | `rails db:migrate` | Run pending db migrations |
| `rdmd` | `rails db:migrate:down` | Undo specific db migration |
| `rdmr` | `rails db:migrate:redo` | Redo specific db migration |
| `rdms` | `rails db:migrate:status` | Show current db migration status |
| `rdmtc` | `rails db:migrate db:test:clone` | Run pending migrations and clone db into test database |
| `rdmu` | `rails db:migrate:up` | Run specific db migration |
| `rdr` | `rails db:rollback` | Roll back the last migration |
| `rdrs` | `rails db:reset` | Delete the database and set it up again |
| `rds` | `rails db:seed` | Seed the database |
| `rdsl` | `rails db:schema:load` | Load the database schema |
| `rdtc` | `rails db:test:clone` | Clone the database into the test database |
| `rdtp` | `rails db:test:prepare` | Duplicate the db schema into your test database |
| `rgen` | `rails generate` | Generate boilerplate code |
| `rgm` | `rails generate migration` | Generate a db migration |
| `rlc` | `rails log:clear` | Clear Rails logs |
| `rmd` | `rails middleware` | Interact with Rails middlewares |
| `rn` | `rails notes` | Search for notes (`FIXME`, `TODO`) in code comments |
| `rp` | `rails plugin` | Run a Rails plugin command |
| `rr` | `rails routes` | List all defined routes |
feat(rails): add some aliases (#11739)
2023-06-15 09:03:45 +00:00
| `rrc` | `rails routes --controller` | List and filter routes mapped to specific controller |
| `rre` | `rails routes --expanded` | List all defined routes in expanded table mode |
| `rrg` | `rails routes --grep` | List and filter the defined routes |
| `rru` | `rails routes --unused` | List unused routes |
feat(rails)!: run old rake aliases with `rails` (#9601) BREAKING CHANGE: we've updated the aliases that run `rake` to use `rails` instead because that's how they are run since Rails v5. The old `rake` aliases can still be run by using the `rk` prefix (e.g. the `rake test` alias has been changed from `rt` to `rkt`). Closes #9601 Closes #9813 Fixes #10696 Co-authored-by: Vsevolod Voloshyn <seva.voloshin@gmail.com>
2021-01-15 19:23:15 +00:00
| `rs` | `rails server` | Launch a web server |
| `rsb` | `rails server --bind` | Launch a web server binding it to a specific IP |
| `rsd` | `rails server --debugger` | Launch a web server with debugger |
| `rsp` | `rails server --port` | Launch a web server and specify the listening port |
| `rsts` | `rails stats` | Print code statistics |
| `rt` | `rails test` | Run Rails tests |
feat(rails): add `rta` alias (#11553)
2023-03-10 14:52:44 +00:00
| `rta` | `rails test:all` | Runs all Rails tests, including system tests |
feat(rails)!: run old rake aliases with `rails` (#9601) BREAKING CHANGE: we've updated the aliases that run `rake` to use `rails` instead because that's how they are run since Rails v5. The old `rake` aliases can still be run by using the `rk` prefix (e.g. the `rake test` alias has been changed from `rt` to `rkt`). Closes #9601 Closes #9813 Fixes #10696 Co-authored-by: Vsevolod Voloshyn <seva.voloshin@gmail.com>
2021-01-15 19:23:15 +00:00
| `ru` | `rails runner` | Run Ruby code in the context of Rails |
rails: create README (#5841)
2019-04-15 17:29:49 +00:00
feat(rails): add `fmns` alias for `foreman start` (#9600) Closes #9600
2021-01-15 04:03:48 +00:00
### Foreman
| Alias | Command | Description |
| ------ | --------------- | ----------------------------------------- |
| `fmns` | `foreman start` | Interact with your Rails app from the CLI |
rails: create README (#5841)
2019-04-15 17:29:49 +00:00
### Utility aliases
| Alias | Command | Description |
feat(rails)!: run old rake aliases with `rails` (#9601) BREAKING CHANGE: we've updated the aliases that run `rake` to use `rails` instead because that's how they are run since Rails v5. The old `rake` aliases can still be run by using the `rk` prefix (e.g. the `rake test` alias has been changed from `rt` to `rkt`). Closes #9601 Closes #9813 Fixes #10696 Co-authored-by: Vsevolod Voloshyn <seva.voloshin@gmail.com>
2021-01-15 19:23:15 +00:00
| --------- | ----------------------------- | ---------------------------------------------- |
rails: create README (#5841)
2019-04-15 17:29:49 +00:00
| `devlog` | `tail -f log/development.log` | Show and follow changes to the development log |
| `prodlog` | `tail -f log/production.log` | Show and follow changes to the production log |
| `testlog` | `tail -f log/test.log` | Show and follow changes to the test log |
### Environment settings
| Alias | Command | Description |
feat(rails)!: run old rake aliases with `rails` (#9601) BREAKING CHANGE: we've updated the aliases that run `rake` to use `rails` instead because that's how they are run since Rails v5. The old `rake` aliases can still be run by using the `rk` prefix (e.g. the `rake test` alias has been changed from `rt` to `rkt`). Closes #9601 Closes #9813 Fixes #10696 Co-authored-by: Vsevolod Voloshyn <seva.voloshin@gmail.com>
2021-01-15 19:23:15 +00:00
| ----- | ----------------------- | ------------------------------- |
rails: create README (#5841)
2019-04-15 17:29:49 +00:00
| `RED` | `RAILS_ENV=development` | Sets `RAILS_ENV` to development |
| `REP` | `RAILS_ENV=production` | Sets `RAILS_ENV` to production |
| `RET` | `RAILS_ENV=test` | Sets `RAILS_ENV` to test |
These are global aliases. Use in combination with a command or just run them
rails: fix typo in README (#7923)
2019-06-12 17:45:43 +00:00
separately. For example: `REP rake db:migrate` will migrate the production db.
rails: create README (#5841)
2019-04-15 17:29:49 +00:00
chore(rails): fix comments and docs
2022-03-07 14:20:03 +00:00
## Legacy
### Rake aliases
feat(rails)!: run old rake aliases with `rails` (#9601) BREAKING CHANGE: we've updated the aliases that run `rake` to use `rails` instead because that's how they are run since Rails v5. The old `rake` aliases can still be run by using the `rk` prefix (e.g. the `rake test` alias has been changed from `rt` to `rkt`). Closes #9601 Closes #9813 Fixes #10696 Co-authored-by: Vsevolod Voloshyn <seva.voloshin@gmail.com>
2021-01-15 19:23:15 +00:00
The following commands are run [using `rails` instead of `rake` since Rails v5][1], but are preserved under the
prefix `rk` for backwards compatibility.
[1]: https://guides.rubyonrails.org/v5.2/command_line.html#bin-rails
| Alias | Command | Description |
| -------- | ------------------------------- | ------------------------------------------------------ |
| `rkdc` | `rake db:create` | Create the database |
| `rkdd` | `rake db:drop` | Delete the database |
| `rkdm` | `rake db:migrate` | Run pending db migrations |
| `rkdms` | `rake db:migrate:status` | Show current db migration status |
| `rkdmtc` | `rake db:migrate db:test:clone` | Run pending migrations and clone db into test database |
| `rkdr` | `rake db:rollback` | Roll back the last migration |
| `rkdrs` | `rake db:reset` | Delete the database and set it up again |
| `rkds` | `rake db:seed` | Seed the database |
| `rkdsl` | `rake db:schema:load` | Load the database schema |
| `rkdtc` | `rake db:test:clone` | Clone the database into the test database |
| `rkdtp` | `rake db:test:prepare` | Duplicate the db schema into your test database |
| `rklc` | `rake log:clear` | Clear Rails logs |
| `rkmd` | `rake middleware` | Interact with Rails middlewares |
| `rkn` | `rake notes` | Search for notes (`FIXME`, `TODO`) in code comments |
| `rksts` | `rake stats` | Print code statistics |
| `rkt` | `rake test` | Run Rails tests |
chore(rails): fix comments and docs
2022-03-07 14:20:03 +00:00
### Other
rails: create README (#5841)
2019-04-15 17:29:49 +00:00
| Alias | Command |
feat(rails)!: run old rake aliases with `rails` (#9601) BREAKING CHANGE: we've updated the aliases that run `rake` to use `rails` instead because that's how they are run since Rails v5. The old `rake` aliases can still be run by using the `rk` prefix (e.g. the `rake test` alias has been changed from `rt` to `rkt`). Closes #9601 Closes #9813 Fixes #10696 Co-authored-by: Vsevolod Voloshyn <seva.voloshin@gmail.com>
2021-01-15 19:23:15 +00:00
| ------- | ---------------------------------- |
| `sc` | `ruby script/console` |
rails: create README (#5841)
2019-04-15 17:29:49 +00:00
| `sd` | `ruby script/destroy` |
feat(rails)!: run old rake aliases with `rails` (#9601) BREAKING CHANGE: we've updated the aliases that run `rake` to use `rails` instead because that's how they are run since Rails v5. The old `rake` aliases can still be run by using the `rk` prefix (e.g. the `rake test` alias has been changed from `rt` to `rkt`). Closes #9601 Closes #9813 Fixes #10696 Co-authored-by: Vsevolod Voloshyn <seva.voloshin@gmail.com>
2021-01-15 19:23:15 +00:00
| `sd` | `ruby script/server --debugger` |
| `sg` | `ruby script/generate` |
rails: create README (#5841)
2019-04-15 17:29:49 +00:00
| `sp` | `ruby script/plugin` |
| `sr` | `ruby script/runner` |
| `ssp` | `ruby script/spec` |
feat(rails)!: run old rake aliases with `rails` (#9601) BREAKING CHANGE: we've updated the aliases that run `rake` to use `rails` instead because that's how they are run since Rails v5. The old `rake` aliases can still be run by using the `rk` prefix (e.g. the `rake test` alias has been changed from `rt` to `rkt`). Closes #9601 Closes #9813 Fixes #10696 Co-authored-by: Vsevolod Voloshyn <seva.voloshin@gmail.com>
2021-01-15 19:23:15 +00:00
| `sstat` | `thin --stats "/thin/stats" start` |
chore(rails): fix comments and docs
2022-03-07 14:20:03 +00:00
- `remote_console <server> <directory>`: runs `ruby script/console production` on a remote server.
Copy permalink