RubyMine 2021.1 Help

Run/debug configurations

RubyMine uses run/debug configurations to run, debug, deploy, and test your code. Each configuration is a named set of run/debug startup properties.

You can customize these properties according to your requirements, for example:

  • For the Rails run/debug configuration, you can specify a server type (such as Puma or Passenger), IP address and port, environment (development by default), and so on.

  • For the Ruby run/debug configuration, you can define command-line arguments, pass the required environment variables, and so on.

  • For RSpec, you can choose a folder containing the required tests and provide custom runner options.

Let's see on how to work with run/debug configurations in general - from creating a temporary configuration to sharing configurations through VCS.

Run/debug configurations can be created as:

  • Temporary– created every time you run a Ruby script, Rails server, test, or another command without configuration.
    The maximum number of temporary configurations is 5. The older ones are automatically deleted when new ones are added.

  • Permanent– created explicitly from a template or by saving a temporary configuration. Permanent configurations remain as part of your project until you remove them.

So whenever you run/debug or test your code, RubyMine either uses an existing permanent run/debug configuration or creates a new temporary one.

Permanent configurations have opaque icons while the icons of temporary configurations are semi-transparent.

Create permanent run/debug configurations

RubyMine provides the following ways to create a permanent run/debug configuration:

Save a temporary configuration as permanent

  • Select a temporary configuration in the run/debug configuration switcher and then click Save Configuration.

    Edit run configurations
  • Alternatively, select a temporary configuration in the Run/debug configurations dialog and click Save on the toolbar.

RubyMine provides run/debug configuration templates for different languages, tools, and frameworks. The list of available templates varies depending on the installed/bundled plugins.

Create a run/debug configuration from a template

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

    • Select Run | Edit Configurations from the main menu.

    • With the Navigation bar visible (View | Appearance | Navigation Bar), choose Edit Configurations from the run/debug configuration selector.

      Edit run configurations

    • Press Alt+Shift+F10, then press 0 or select the configuration from the popup and press F4.

  2. In the Run/Debug Configuration dialog, click Icons general add on the toolbar or press Alt+Insert. The list shows the run/debug configuration templates.

    New run/debug configuration
  3. For a new run/debug configuration, specify the following settings:

    Run/Debug Configurations: Rails
    • Name: specifies the configuration name.

    • Allow parallel run: If this option is enabled, you can launch a run configuration multiple times in parallel instead of rerunning it. Each runner will start in its own tab of the Run or Debug tool window.

    • Store as project file: Enable this option to save your configuration as a project file and share it with team members through VCS.

    • Configure settings specific for the selected configuration type (for example, Ruby, Rails, or RSpec).

    • Before Launch: In this area, you can specify tasks that must be performed before running a configuration.

    • Show this page: Enable this option to show the run/debug configuration settings prior to actually starting it.

    • Activate tool window: Use this option to specify whether or not the Run/Debug tool window opens when you start the run/debug configuration.

  4. Apply the changes and close the dialog.

Share run/debug configurations

If you are working in a team, you might want to share your run/debug configurations so that your teammates could run the application using the same configuration or enable them to remotely attach to the process you are running.

For these purposes, RubyMine provides a mechanism to store your run/debug configurations as project files and share them through VCS. The same mechanism can also be used when you want to send your configuration as a file to someone else. This saves a lot of time as run/debug configurations sometimes get sophisticated, and keeping them in sync manually would be tedious and error-prone.

  1. From the main menu, select Run | Edit Configurations. Alternatively, press Alt+Shift+F10, then 0.

  2. Select the run/debug configuration you want to share, enable the Store as project file option, and specify the location where the configuration file will be stored.

    If compatibility with RubyMine 2019.3 and earlier is required, store the file in the default location.

  3. (Optional) If the .idea directory is added to VCS ignored files, the .idea/runConfigurations subfolder will be ignored, too. If you use Git for your project, you can share .idea/runConfigurations only and leave .idea ignored by modifying .gitignore as follows:

    /.idea/* !/.idea/runConfigurations

Run/debug configuration templates

Each type of run/debug configuration is a template that you can edit, so the next time you create a new configuration of that type, its parameters already have the desired values.

Configure the default values for a template

  1. From the main menu, select Run | Edit Configurations. Alternatively, press Alt+Shift+F10, then 0.

  2. In the left-hand pane of the run/debug configuration dialog, click Edit configuration templates.

    Edit configuration templates
  3. In the Run/Debug Configuration Templates dialog that opens, select a configuration type.

    run/debug templates
  4. Specify the desired default parameters and click OK to save the template.

Compound run/debug configurations

Suppose you would like to launch multiple run/debug configurations simultaneously. For example, you may want to run several configurations of different types or a sequence of several test configurations. You can configure this behavior with a compound run/debug configuration.

When you run or debug your code using a compound configuration, you actually launch a sequence of configurations in the order they are listed.

Create a compound run/debug configuration

  1. From the main menu, select Run | Edit Configurations. Alternatively, press Alt+Shift+F10, then 0.

  2. In the Run/Debug Configurations dialog, click the Add button or press Alt+Insert, then select Compound.

  3. Specify the run/debug configuration name in the Name field. This name will be shown in the list of the available run/debug configurations.

  4. Select Store as project file to make this run/debug configuration available to other team members.

  5. To include a new run/debug configuration into the compound configuration, click Add the Add button and select the desired one from the list.

  6. Apply the changes.

Run/debug configuration folders

When there are many run/debug configurations of the same type, you can group them in folders so they become easier to distinguish visually.

Once grouped, the run/debug configurations appear in the list under the corresponding folders.

folders for run configurations

Create a folder for run/debug configurations

  1. From the main menu, select Run | Edit Configurations. Alternatively, press Alt+Shift+F10, then 0.

  2. In the Run/Debug Configurations dialog, select a configuration type and click the New Folder icon on the toolbar. A new empty folder for the selected type is created.

  3. Specify the folder name in the text field to the right or accept the default name.

  4. Select the desired run/debug configurations and move them under the target folder.

  5. Apply the changes. If a folder is empty, it will not be saved.

When you no longer need a folder, you can delete it Delete. The run/debug configurations grouped under this folder will be moved under the root of the corresponding run/debug configuration type.

Before launch tasks

When you are creating or editing a configuration, you can specify tasks that must be performed before running a configuration using the Before Launch. For example, you can run the db:prepare Rake task before running a test configuration.

To add a task, click the Add button and select the desired task.

List of tasks

  • Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in RubyMine yet, add its definition. For more information, see External tools.

  • Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.

  • Launch Web Browser: open the specified URL in a browser.

  • Run Grunt task: select this option to run a Grunt task.

  • Run Gulp task: select this option to run a Gulp task.

  • Run npm Script: select this option to execute an npm script.

  • Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected:

    • If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.

    • If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched.

  • Generate CoffeeScript Source Maps: select this option to generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located

  • Run Remote External tool: add a remote SSH external tool.

  • Run Shell Script: allows you to run a specified shell script. Note that you need to create the Shell Script configuration for this.

  • Run Rake task: add a Rake task to be executed prior to running or debugging.

  • Run JRuby compiler: choose this option to execute JRuby compiler with the specified target path, compiler process heap size, and command line parameters (if any).

Last modified: 27 May 2021