Run/Debug Configuration: Ruby Remote Debug
This feature is supported in the Ultimate edition only.
The following is only valid when Ruby Plugin is installed and enabled!
Use this dialog box to define configuration for remote debugging of the Ruby scripts.
In this section:
Prerequisites
Before you start working with Ruby, make sure that Ruby plugin is installed and enabled. The plugin is not bundled with IntelliJ IDEA.
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:
Information and settings
Item | Description |
---|---|
Name | In this text box, specify the name of the current run/debug configuration. |
Server command | Use the following command on the server side to enable remote debug:
rdebug-ide --host 0.0.0.0 --port <port number> --dispatcher-port <port number> -- $COMMAND$
This read-only field shows the command that should be entered on the server side to launch the debug server. Port and dispatcher-port numbers here are taken from the Port and Local port fields. $COMMAND$ corresponds to the name of the script to be debugged. |
Remote host | Specify URL of the host where remote debugging will take place. |
Remote port | Specify the port number on the server side. Note that the number entered in this field, is automatically used in the rdebug command. As you type port number, the suggested command string changes accordingly. |
Remote root folder | Specify the root directory on the server side, where the script to be debugged is located. This field defines mapping to the local root folder. |
Local port | Specify the local port number. Note that the number entered in this field, is automatically used in the rdebug command. As you type the local port number, the suggested command string changes accordingly. |
Local root folder | Specify the local root directory containing the script in question. Type the path, or click and find the desired root in the Select Path dialog box. |
Toolbar
Item | Shortcut | Description |
---|---|---|
Alt+Insert | Click this button to add a new configuration to the list. | |
Alt+Delete | Click this button to remove the selected configuration from the list. | |
Ctrl+D | Click this button to create a copy of the selected configuration. | |
Edit defaults | Click this button to edit the default configuration templates. The defaults are used for newly created configurations. | |
or | Alt+Up or Alt+Down | Use these buttons to move the selected configuration or folder up and down in the list. The order of configurations or folders in the list defines the order in which configurations appear in the Run/Debug drop-down list on the main toolbar. |
Move into new folder / Create new folder | Use this button to create a new folder. If one or more run/debug configurations are in focus, the selected run/debug configurations are automatically moved to the newly created folder. If only a category is in focus, an empty folder is created. Move run/debug configurations to a folder using drag-and-drop, or the buttons. | |
Sort configurations | Click this button to sort configurations in alphabetical order. |
Common options
Item | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | In this text box, specify the name of the current run/debug configuration. This field does not appear for the default run/debug configurations. | ||||||||||||||||||||||||
Defaults | This node in the left-hand pane of the dialog box contains the default run/debug configuration settings. Select the desired configuration to change its default settings in the right-hand pane. The defaults are applied to all newly created run/debug configurations. | ||||||||||||||||||||||||
Share | Select this check box to make the run/debug configuration available to other team members. If the directory-based project format is used, the settings for a run/debug configuration are stored in a separate .xml file in the If the file-based format is used, the settings are stored in the This check box is not available when editing the run/debug configuration defaults. | ||||||||||||||||||||||||
Single instance only | If this check box is selected, this run/debug configuration cannot be launched more than once. Every time a new run/debug configuration is launched, IntelliJ IDEA checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog box. If you click OK in the confirmation dialog box, the first instance of the runner will be stopped, and the next one will take its place. This makes sense when the usage of certain resources can cause conflicts, or when launching two run/debug configurations of the same type consumes too much of the CPU and memory resources. If this check box is not selected, it is possible to launch as many instances of the runner as required. So doing, each runner will start in its own tab of the Run tool window. | ||||||||||||||||||||||||
Before launch | Specify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.
|