Run/Debug Configuration: Rack
Use this run/debug configurations to execute Rack applications in the specified environment.
Prerequisites
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.
For more information, refer to their respective download and installation pages:
Configuration tab
Item | Description |
---|---|
Server | Select the server to run or debug your application on. |
IP Address | Specify the IP address where the server will be accessible. |
Port | Specify the port to listen to. |
Rack config file | Specify here the path to the Rack configurations file. |
Environment variables | Specify the list of environment variables as the name-value pairs, separated with semi-colons. Alternatively, click |
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 browser | If this checkbox is selected, a new tab will be added to your system default browser, where the application will be run or debugged. You can specify the required URL in the text field below, or use the one suggested by IntelliJ IDEA. Note that the default URL is automatically composed on the base of the IP address and port specified above. If this checkbox is not selected, you have to launch the required browser manually. |
Start JavaScript debugger automatically | If this checkbox is selected, the JavaScript debugger will be enabled. |
Bundler tab
Item | Description |
---|---|
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.
Item | Description |
---|---|
Packages and classes to include in coverage data | Click |
Packages and classes to exclude from coverage data | Click |
Logs tab
Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.
Item | Description |
---|---|
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:
|
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. |
Common settings
When you edit a run configuration (but not a run configuration template), you can specify the following options:
Item | Description |
---|---|
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. |
Toolbar
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.
Item | Shortcut | Description |
---|---|---|
Alt+Insert | Create a run/debug configuration. | |
Alt+Delete | Delete the selected run/debug configuration. Note that you cannot delete default configurations. | |
Ctrl+D | 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 Then, to move a configuration into a folder, between the folders or out of a folder, use drag or To remove grouping, select a folder and click | ||
Click this button to sort configurations in the alphabetical order. |
Before launch
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.
Item | Shortcut | Description |
---|---|---|
Alt+Insert | Click this icon to add one of the following available tasks:
| |
Alt+Delete | Click this icon to remove the selected task from the list. | |
Enter | Click this icon to edit the selected task. Make the necessary changes in the dialog that opens. | |
Alt+Up Alt+Down | 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 | By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration. 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. |