IntelliJ IDEA 2019.1 Help

Running Rails Console

IntelliJ IDEA allows you to run the Rails console and interact with your application without leaving the IDE. You can use completion and navigation capabilities, run the console with additional options, and so on.

Before using the Rails console, make sure that the rails gem is installed for your interpreter.

Run the Rails console

To run the Rails console in IntelliJ IDEA, perform the steps below:

  1. Do one of the following:

    • Press Ctrl twice, start typing Rails console, select the corresponding item in the popup and press Enter.

    • From the main menu, go to Tools | Run Rails Console.

  2. In the invoked dialog, select the required environment and press OK.

IntelliJ IDEA will load the Rails console with the selected project SDK.

Rails console

Note that the Rails console can be launched on a remote SDK.

Run the console with additional options

After you run the console for the first time, IntelliJ IDEA creates the dedicated run configuration. If necessary, you can change the created configuration to provide additional options: change the environment, protect the database from changing data, and so on. For example, to use the --sandbox option to run the console, perform the steps below:

  1. Open the Run/Debug Configurations dialog in one of the following ways:

    • Press Ctrl+Shift+A, start typing Edit Configurations, select it from the list and press Enter.

    • Expand the run/debug configuration selector on the main toolbar and select Edit Configurations.

  2. In the invoked Run/Debug Configurations dialog, select the created Rails console configuration in the IRB Console group and specify the IRB Arguments option in the following way:

    console --sandbox

    Click OK.

You can now run this configuration and use the Rails console without changing the database.

Run source code from the editor to the console

IntelliJ IDEA allows you to run source code from the editor in the Rails console. To do this, perform the following steps:

  1. Open the required Ruby file in the editor (if necessary, select a fragment of code to be executed).

  2. On the main menu, choose Tools | Load file/selection into IRB/Rails console, or press N/A.

Productivity tips

Complete names

Use basic code completion (Ctrl+Space) to complete names of classes, methods, and so on.

Navigate through history

Use the Up and Down arrow keys to scroll through the history of commands, and execute the required ones.

Navigate to source code

To navigate to the initial declaration of a symbol and symbol's type, place the caret at the desired symbol and press Ctrl+B.

View quick documentation

To get quick information for any symbol or method signature, place the caret at the desired symbol and press Ctrl+Q.

Last modified: 20 May 2019