Run/Debug Configuration: Rails

Server

Specify a web server for running a Rails application. You might need to install a corresponding gem to the project SDK (for example, Puma, Passenger, and so on). You can find the full list of supported Rails servers here: Supported versions of Ruby-related technologies.

IP Address

Specify the IP address where the Rails server will be accessible.

If you use Puma with unix socket binding for running your application, it is not required to specify the IP address of the server. If the value is not provided, IntelliJ IDEA will omit the -b <IP Address> option when running the rails server command.

If the IP address is not provided, the browser preview of HTML and ERB files is not available.

Port

Specify the port to run the Rails server.

If you use Puma with unix socket binding for running your application, it is not required to specify the IP address of the server. If the value is not provided, IntelliJ IDEA will omit the -b <IP Address> option when running the rails server command.

If the IP address is not provided, the browser preview of HTML and ERB files is not available.

Server arguments

Type optional server arguments. You can run the rails server --help command in the terminal emulator to learn more about available arguments.

Environment

Select the required Rails environment to run the server (development, production, or test).

Dummy app

This field is only enabled for the Rails mountable engine projects. Specify the absolute path to the dummy directory. This path is required to run the engine.

Run browser

Select this option to enable opening an application automatically in a default browser.

If you enable the option, provide a browser URL to ensure that IntelliJ IDEA will not run the JS debugger.

Start JavaScript debugger automatically when debugging

Enable this option to start the JavaScript debugger.

warning

Debugging of JavaScript code is only supported in Google Chrome and in other Chromium-based browsers.

Environment variables

Specify the list of environment variables as the name-value pairs, separated with semi-colons. Alternatively, click to create variables and specify their values in the Environment Variables dialog.

Ruby arguments

Specify the command-line arguments to be passed to the Ruby interpreter.

Ruby SDK

Specify the desired Ruby interpreter. You can choose the project default Ruby SDK, or select a different one from the list of configured Ruby SDKs.

Run the script in the context of the bundle ('bundle exec')

Running the script with Bundler ensures that the gem versions specified in the Gemfile will be used. Select one of the options:

• Auto-detection: select this option to run your code with bundle exec when it is possible.

  note

  When the Auto-detection option is enabled, IntelliJ IDEA checks whether the following conditions are met:

  • Gemfile and Gemfile.lock are present

  • The version of the bundler gem specified in Gemfile.lock is also installed in the run/debug configuration's SDK

  In case either of these conditions isn't met, the executed command will remain without any changes.

• Disabled: select this option to disable the use of bundle exec.

Choose coverage runner

Select the desired code coverage runner.

By default, IntelliJ IDEA uses its own coverage engine with the Sampling mode. You can also choose JaCoCo for calculating coverage.

Sampling

Select this option to measure code coverage with minimal slow-down.

Tracing

Select this option to collect accurate branch coverage. This mode is available for the IntelliJ IDEA code coverage runner only.

Track per test coverage

Select this checkbox to detect lines covered by one test and all tests covering line. If this checkbox is selected, becomes available on the toolbar of the coverage statistic popup.

note

This option is only available for the Tracing mode of code coverage measurement for the testing run/debug configurations.

For more information, refer to Set coverage in run configurations.

Packages and classes to record code coverage data

Click and select Add Class or Add Package to specify classes and packages to be measured. You can also remove classes and packages from the list by selecting them in the list and clicking the button.

Enable coverage in test folders

If this checkbox is selected, the folders marked as test are included in the code coverage analysis.

Is Active

Select checkboxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.

Log File Entry

The read-only fields in this column list the log files to show. The list can contain:

• Full paths to specific files.

• Ant patterns that define the range of files to be displayed.

• Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown.

  If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.

Skip Content

Select this checkbox to have the previous content of the selected log skipped.

Save console output to file

Select this checkbox to save the console output to the specified location. Type the path manually, or click the browse button and point to the desired location in the dialog that opens.

Show console when a message is printed to standard output stream

Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.out.

Show console when a message is printed to standard error stream

Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.err.

Click this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.

Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.

Click this button to remove the selected log entry from the list.

Name

Specify a name for the run configuration to quickly identify it among others when editing or running.

Allow multiple instances

Allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, IntelliJ IDEA suggests stopping the running instance and starting another one. This is helpful when a run configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and IntelliJ IDEA stores run configuration settings in .idea/workspace.xml.

AltInsert

Create a run/debug configuration.

AltDelete

Delete the selected run/debug configuration. Note that you cannot delete default configurations.

Ctrl0D

Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.

The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.

Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders.

To create a folder, select the configurations within a category, click , and specify the folder name. If only a category is in focus, an empty folder is created.

Then, to move a configuration into a folder, between the folders or out of a folder, use drag or and buttons.

To remove grouping, select a folder and click .

Click this button to sort configurations in the alphabetical order.