JetBrains Rider 2024.1 Help

Run/debug configurations

JetBrains Rider uses run/debug configurations to run, debug, deploy, and test your code. Each configuration is a named set of startup properties that define what to execute and what parameters and environment should be used.

There are two types of run/debug configurations:

  • Temporary — created every time you run/debug a .NET static method from the editor.

  • 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, JetBrains Rider 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. The red cross over the configuration icon indicates an error in configuration settings.

The maximum number of temporary configurations is 5. The older ones are automatically deleted when new ones are added. If necessary, you can increase this limit in Settings/Preferences | Advanced Settings | Run/Debug | Temporary configurations limit.

Create permanent run/debug configurations

JetBrains Rider 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, click /, and select Save Configuration.

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

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

Create a run/debug configuration from a template

  1. Go to Run | Edit Configurations. Alternatively, press Alt+Shift+F10, then 0.

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

    Select the desired template. If you are not sure which template to choose, refer to List of run/debug configuration templates for more information on particular templates.

  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 Allow multiple instances if you want to allow multiple instances of the configuration to run at the same time. If this option is disabled, attempting to re-run the configuration will terminate the active session.

  5. Configure the run/debug configuration parameters. The list of mandatory and optional parameters may vary depending on the selected run/debug configuration type.

    Some optional parameters are hidden. To view and enable them, click the Modify options link.

    For the detailed description of the selected template, see the respective section of run/debug configurations reference.

  6. In the Before launch section, define whether you want to perform any specific actions before launching the application, for example, launch an external tool or another build configuration before run. To skip the build stage, remove Build from the Before launch list .

    For more information about particular Before launch activities, refer to Before launch

  7. You can either run the configuration right away, or save the configuration to run it later.

    • Click OK to save the run configuration for later and close the dialog.

    • To run the configuration right away, click Run.

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, JetBrains Rider 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. Go to 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.

    By default, shared configurations are saved in the .run folder in the solution directory.

Run/debug configuration templates

All run/debug configurations are based on templates, which implement the startup logic, define the list of parameters and their default values. The list of available templates is predefined in the installation and can only be extended via plugins. However, you can edit default parameter values in each template to streamline the setup of new run/debug configurations.

Configure the default values for a template

  1. Go to 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….

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

  4. Specify the desired default parameters and click OK to save the template.

Environment variables and program arguments

You can influence the runtime behavior of your app by adding program arguments and environment variables to suitable run/debug configurations.

  1. Go to Run | Edit Configurations. Alternatively, press Alt+Shift+F10, then 0.

  2. In the Run/Debug Configurations dialog that opens, select a configuration where you want to pass the arguments and add the environment variables.

    Program arguments
  3. Type the arguments in the Program arguments field. The arguments should be separated with spaces or new lines.

    Click the Expand field icon to expand the text field, so you can view and edit the arguments as a list.

  4. In the Environment variables field, type the variable name and value: <name>=<value>. If you add several variables, they should be separated with semicolons.

    Alternatively, click the Environment variables icon and add the variable name and value to the User environment variables list.

    Adding environment variables

    In the dialog that opens, you can also see the list of available system environment variables. Clear the System environment variables checkbox if you don't want to use the system environment variables for the selected configuration.

    You can reference existing variables, including the parent environment variables, using the $VAR$ syntax. Note that such references are case-sensitive: for example, PATH=xxx:$PATH$ for Linux/macOS and Path=xxx;$Path$ for Windows.

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.

Create a folder for run/debug configurations

  1. Go to 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.

Run/Debug configurations in the Services tool window

You can manage multiple run/debug configurations in the Services tool window. For example, you can start, pause, and stop several applications, track their status, and examine application-specific details.

Add Run/Debug configurations to the Services window

  1. Select View | Tool Windows | Services from the main menu or press Alt+8.

  2. In the Services tool window, click Add service, then select Run Configuration Type….

    Services tool window: Add run configuration
  3. Select a run/debug configuration type from the list to add all configurations of this type to the window.

    Note that the tool window will only display the configuration types for which you have created one or more configurations.

Execute tasks before launching a run/debug configuration

Most types of run/debug configurations have the Before Launch section where you can specify tasks that must be performed before executing the configuration. For example, you may want to automatically build your solution before starting the application.

To add a task, expand the Before Launch section, click Add Add, select the desired task type and specify its parameters if required.

You can execute the following tasks before launching a run/debug configuration:

Launch Web Browser

Opens the specified URL in the selected browser.

Run External tool

Starts another application configured in External Tools. In the dialog that opens, select one or multiple applications you want to run.

Run Another Configuration

Starts another run/debug configuration. In contrast to the Compound configuration, this way of running multiple configurations lets you define the order in which the configurations are started.

Build Project

Builds any project from the current solution. If the configuration targets a specific project, you can choose Selected project to build the project selected in the configuration settings. If an error occurs during compilation, JetBrains Rider won't attempt to start the run/debug configuration.

Clean Project

Removes all build artifacts — intermediate and output files of a specified project.

Build Solution

Builds entire solution.

Clean Solution

Removes all build artifacts — intermediate and output files from the solution.

Publish Solution

Run File Watchers

Applies all currently active file watchers.

Run Remote External tool

Executes a remote SSH external tool.

Run Grunt task

Runs a Grunt task.

Run Gulp task

Runs a Gulp task.

Run npm script

Executes an npm script.

Compile TypeScript

Runs the built-in TypeScript compiler and thus makes 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

Generates the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.

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 yourself by pressing Alt+4 or Alt+5.

Last modified: 28 June 2024