Run/Debug Configuration: Ruby
Use this dialog to define run/debug configuration for a Ruby script.
Before you start working with Ruby, make sure that Ruby plugin is installed and enabled. Press Ctrl+Alt+S, go to Plugins and inspect the Installed tab to ensure the plugin is enabled.
Also make sure that the following prerequisites are met:
Ruby SDK is downloaded and installed on your machine.
The required framework SDKs are downloaded and installed on your machine.
Refer to their respective download and installation pages for details:
In this field, specify the name of the current run/debug configuration.
Specify the fully qualified path to a Ruby script to be executed, or click, and select the desired Ruby script in the dialog that opens.
Specify command-line arguments that will be passed after the script's filename. These arguments will be available to your Ruby program in the global
Specify the working directory used by the running task. For example, this option is in effect when the running script loads other scripts by relative paths.
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.
Specify the command-line arguments to be passed to the Ruby interpreter.
When such a run/debug configuration is launched, IntelliJ IDEA analyzes the running processes, and does one of the following, depending on the presence of the running Nailgun server:
Classpath property is added to Nailgun settings.
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.
Execute in the context of Rails
This option is available for scripts in Rails applications. You can enable it to run scratch or project Ruby scripts in the Rails context.
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:
Code Coverage tab
Use this tab to configure code coverage monitoring options.
Choose coverage runner
Select the desired code coverage runner.
Select this option to measure code coverage with minimal slow-down.
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.
Refer to the section 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.
Run new instance of the Nailgun server, or use already started one
This checkbox is only available for JRuby used as the project interpreter.
When a run/debug configuration, with this checkbox selected, is launched, IntelliJ IDEA analyzes the running processes, and does one of the following, depending on the presence of the running Nailgun server:
If this checkbox is not selected, then the script is launched in a usual way, without Nailgun.
Log File Entry
The read-only fields in this column list the log files to show. The list can contain:
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.
When you edit a run configuration (but not a run configuration template), you can specify the following options:
Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.
Allow parallel run
Select to 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 to stop the running instance and start another one. This is helpful when a run/debug 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.
The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.
Create a run/debug configuration.
Delete the selected run/debug configuration. Note that you cannot delete default configurations.
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.
In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
Click this icon to add one of the following available tasks:
Click this icon to remove the selected task from the list.
Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
Click these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list.
Show this page
Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window
Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.