Skip to content

Commit

Permalink
Merge pull request #2299 from andrehjr/pry-rails-readme-maintained
Browse files Browse the repository at this point in the history
Add disclaimer about pry-rails not being currently maintained
  • Loading branch information
andrehjr committed Feb 14, 2024
2 parents 68203c6 + 046c5a7 commit 2ecbf16
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Expand Up @@ -413,18 +413,21 @@ description if the `--help` option is available.

### Use Pry as your Rails Console

The recommended way to use Pry as your Rails console is to add [the `pry-rails`
gem](https://github.com/rweng/pry-rails) to your Gemfile. This replaces the
default console with Pry, in addition to loading the Rails console helpers and
adding some useful Rails-specific commands.

If you don't want to change your Gemfile, you can still run a Pry console in
your app's environment using Pry's `-r` flag:
You can run a Pry console in your app's environment using Pry's `-r` flag:

```sh
pry -r ./config/environment
```

Or start the rails console (`bin/rails console`) and then type `pry`.

It's also possible to use Pry as your Rails console by adding [the `pry-rails`
gem](https://github.com/pry/pry-rails) to your Gemfile. This replaces the
default console with Pry, in addition to loading the Rails console helpers and
adding some useful Rails-specific commands.

**Note that `pry-rails` is not currently maintained.**

Also check out the
[wiki](https://github.com/pry/pry/wiki/Setting-up-Rails-or-Heroku-to-use-Pry)
for more information about integrating Pry with Rails.
Expand Down

0 comments on commit 2ecbf16

Please sign in to comment.