Rubyscope is a small desktop app for reading Ruby and Rails code. Hold Ctrl and click a class, a method, a route helper, a translation key or a partial. It opens where that thing is written. Built in Rust, for Omarchy Linux and macOS.
Try it. These are real screenshots. Ctrl is held, so Order has an underline. Click it, or click ship! lower down. The tabs above show more kinds of jump.
app/models/order.rb, line 2. The click found the class through Ruby's constant lookup. Use the back button in the top bar to return.
Order#ship!, line 22. Rubyscope knew that order is an Order, because it comes from Order.ready_to_ship.find_each.
Try it. Ctrl is held over the show action in the orders controller. Click it to open its template.
app/views/orders/show.html.erb. The action opened its template. The bar above the code links back to OrdersController#show.
Try it. Ctrl is held over a partial in a template. Click "orders/line_item".
app/views/orders/_line_item.html.erb. The partial name became its file, with the underscore and the template extension.
Try it. Ctrl is held over the route helper order_path. Click it.
config/routes.rb, line 2. order_path comes from resources :orders, so the click opens that line.
Try it. This is where a constant is defined. Ctrl+click FREE_SHIPPING_CENTS to see where it is used.
3 usages of Shop::FREE_SHIPPING_CENTS. A helper, a service and a spec. In the app, a click on a row opens that line, and "callers" goes one level up.
Try it. Ctrl is held over a lazy translation key in the update action. Click ".updated".
config/locales/en.yml, line 9. The lazy key .updated in OrdersController#update is en.orders.update.updated.
A text search finds every ship! in the project. Rubyscope finds the one you mean. It follows Ruby's lookup rules and the conventions of Rails, RSpec, FactoryBot and Stimulus.
Rest the pointer on a name to see its signature, its docs and where it is defined. The popup also says how Rubyscope found the type: exact, inferred, a guess, or by name only.
Rubyscopeclass_methods, delegate, superdb/schema.rb
order comes from a scope on Order, so the call goes to Order#ship!.Ctrl+click the name of an action to open its template or Phlex view. A view shows a link to its action above the code, so the way back is one click too.
def show in the controller.
OrdersController#show.A click on t(".updated") opens the line in the locale file, in every locale. Lazy keys work in controllers, templates and Phlex views. A route helper such as order_path opens the line in the routes file.
render "orders/line_item" opens the partialresources :orders opens the controllerdata-action="order#ship" opens the Stimulus method
OrdersController#update.
en.orders.update.updated in the locale file.Ctrl+click a class name where it is defined, and the results panel lists every place that uses it. For a method, right-click and choose "Find usages". The "callers" button on a row goes one level up the call stack.
Some calls have no known receiver, such as a method on a block argument. Rubyscope then lists every definition with that name, and says how sure it is about each one. It never guesses in silence.
item.ship! could be an order or a gift card.Press Ctrl B. Each line shows the date and the author, and newer lines get a stronger blue. Click a block to open the commit, or its pull request, on GitHub.
Ctrl P finds a file. Ctrl T finds a class, method or constant in the project and its gems. Ctrl K lists every command. Scroll with j and k, and go to the top with gg, as in Vim.
Rubyscope reads the source. It does not boot Rails or run your code, so it works on an app that does not start.
class A::B, constant aliases and Zeitwerk folder namespaces.class << self, extend, module_function, class_eval, ActiveSupport.on_load.delegate, attribute, store_accessor, attachments, schema columns.before_action :load, validate :check, if: :paid?, send(:x).Model.find, relations, block parameters, instance variables, YARD @return, FactoryBot create(:x).resources, to: "a#b", and t("a.b") keys in every locale file.let, subject, described_class, shared examples, factories and traits.Gemfile.lock that is installed, and the Ruby standard library.Rubyscope parses every Ruby file with Prism, on all CPU cores, and saves the index. The next start reads the saved index and parses only the files that changed.
A file watcher sees changes in app, config, db, lib and the specs. Open tabs load the new text and the index updates itself.
Rubyscope never writes into your project. To change a file, open it in your editor from the right-click menu, at the same line.
Rubyscope is built from source with Rust 1.88 or newer, clang and libclang.
git clone https://github.com/equivalent/rubyscope
cd rubyscope
bin/install
rubyscope ~/code/shopInstalls the app in ~/.local/bin with an app launcher entry. Built and used on Omarchy, on Wayland.
git clone https://github.com/equivalent/rubyscope
cd rubyscope
bin/install-macos
rubyscope ~/code/shopInstalls rubyscope.app in ~/Applications. Runs on Apple silicon. Use Cmd where the docs say Ctrl.