Rails 3: I want to list all paths defined in my rails application

Question

I want to list all defined helper path functions (that are created from routes) in my rails 3 application, if that is possible.

Thanks,

open your console and type rake routes – Mohsin Raza Aug 01 '16 at 10:26 — Mohsin Raza, Aug 01 '16 at 10:26

score 262 · Accepted Answer · edited May 04 '23 at 08:17

262

new solution

rails routes

deprecated

rake routes

or

bundle exec rake routes

edited May 04 '23 at 08:17

Kelvin Wang

627
5
21

answered Jul 23 '11 at 16:51

house9

20,359
8
55
61

2

Furthermore, if you want to check whether a given path is *recognized* by your app's router, see [this](http://stackoverflow.com/a/4513327). – XåpplI'-I0llwlg'I - Aug 21 '15 at 07:21
In a specific context, I had to use `RAILS_ENV=dev /opt/rbenv/shims/bundle rake routes` to make this work. – peter_v Jun 13 '19 at 14:36
10

`rake routes` is deprecated; use `rails routes` instead: https://github.com/rails/rails/pull/33660 – nekketsuuu Apr 23 '20 at 07:05

score 98 · Answer 2 · edited Feb 10 '20 at 11:41

98

Update

I later found that, there is an official way to see all the routes, by going to http://localhost:3000/rails/info/routes. Official docs: https://guides.rubyonrails.org/routing.html#listing-existing-routes

Though, it may be late, But I love the error page which displays all the routes. I usually try to go at /routes (or some bogus) path directly from the browser. Rails server automatically gives me a routing error page as well as all the routes and paths defined. That was very helpful :)

So, Just go to http://localhost:3000/routes

edited Feb 10 '20 at 11:41

Yangshun Tay

49,270
33
114
141

answered Sep 07 '15 at 11:16

Anwar

1,755
1
21
32

1

To state the obvious, this only works in development environment. – Dennis Jun 28 '16 at 18:14
7

This is bundled into Rails 4, but the question asks about Rails 3. You'll need to install the Sextant gem to use this in 3. – elc Sep 06 '16 at 18:46

score 36 · Answer 3 · answered Apr 17 '18 at 10:04

36

One more solution is

Rails.application.routes.routes

http://hackingoff.com/blog/generate-rails-sitemap-from-routes/

answered Apr 17 '18 at 10:04

gayavat

18,910
11
45
55

18

`Rails.application.routes.routes.map { |r| {alias: r.name, path: r.path.spec.to_s, controller: r.defaults[:controller], action: r.defaults[:action]}}` – konyak Dec 05 '19 at 21:32
1

```Rails.application.routes.routes.map(&:name).compact``` for just the named routes – smilingfrog Sep 13 '21 at 22:30

score 13 · Answer 4 · edited Jun 23 '22 at 18:23

13

rails routes | grep <specific resource name>

displays resource specific routes, if it is a pretty long list of routes.

edited Jun 23 '22 at 18:23

Sathish Manohar

5,859
10
37
47

answered Apr 02 '18 at 21:18

Wings2fly

887
1
11
31

You can pass `--grep` directly to `rails routes` like: `rails routes --grep "^/password"` – Joe Atzberger Sep 01 '22 at 18:56

score 9 · Answer 5 · edited Apr 04 '16 at 16:04

9

Trying http://0.0.0.0:3000/routes on a Rails 5 API app (i.e.: JSON-only oriented) will (as of Rails beta 3) return

{"status":404,"error":"Not Found","exception":"#> 
<ActionController::RoutingError:...

However, http://0.0.0.0:3000/rails/info/routes will render a nice, simple HTML page with routes.

edited Apr 04 '16 at 16:04

Richard Erickson

2,568
8
26
39

answered Apr 04 '16 at 15:05

Daniel Huffman

91
1
1

Al Duncanson · Answer 6 · 2021-09-15T13:50:03.737

CLI

updated for version 6

To list all existing routes you'll want to run the command:

bundle exec rails routes

bundle exec will

Execute a command in the context of the bundle

and rails routes will

list all of your defined routes

Example

If you have your resource route declared like so:

resource :credential, only: [:new, :create, :destroy]

Then it's helpful to pipe the output so you can grep for your specific resource.

For example:

Rails 3: I want to list all paths defined in my rails application

6 Answers6

Update

CLI

Example