JetBrains Rider 2024.1 Help

Command-line interface

Use JetBrains Rider features from the command line: open files and projects, view diffs, merge files, apply code style, formatting, and inspect the source code.

Launcher for a standalone instance

The installation directory contains batch scripts and executables for launching JetBrains Rider, formatting the source code, and running inspections. To use them from the Command Prompt cmd.exe, add the location of the JetBrains Rider bin folder to the PATH environment variable. For example, if you installed JetBrains Rider to C:\Program Files\JetBrains\JetBrains Rider, you can use the following command:

set PATH=%PATH%;C:\Program Files\JetBrains\JetBrains Rider\bin

This command changes the PATH environment variable for the current shell only (the current instance of cmd.exe). If you want to update it permanently for the current user, run setx:

setx PATH "%PATH%;C:\Program Files\JetBrains\JetBrains Rider\bin"

To update it system-wide for all users, run setx /M instead of setx.

After you configure the PATH variable, you can run the executable from any working directory in the Command Prompt:

rider64.exe

Alternatively, you can use the batch script:

rider.bat

To run JetBrains Rider from the shell, use the open command with the following options:

-a

Specify the application.

-n

Open a new instance of the application even if one is already running.

--args

Specify additional arguments to pass to the application.

For example, you can run Rider 2024.1.app with the following command:

open -na "Rider 2024.1.app"

You can create a shell script with this command in a directory from your PATH environment variable. For example, create the file /usr/local/bin/rider with the following contents:

#!/bin/sh open -na "Rider 2024.1.app" --args "$@"

Make sure you have permissions to execute the script and since /usr/local/bin should be in the PATH environment variable by default, you should be able to run rider from anywhere in the shell.

If you do not have permissions to execute the script, run the following:

chmod +x /usr/local/bin/rider

On Linux, the installation directory contains the launcher shell script rider.sh under bin. For example, if you installed JetBrains Rider to /opt/rider, you can run the script using the following command:

/opt/rider/bin/rider.sh

You can create a symbolic link to the launcher script in a directory from the PATH environment variable. For example, if you want to create a link named rider in /usr/local/bin, run the following command:

ln -s /opt/rider/bin/rider.sh /usr/local/bin/rider

Since /usr/local/bin should be in the PATH environment variable by default, you should be able to run the rider command from anywhere in the shell.

Shell scripts generated by the Toolbox App

If you are using the Toolbox App to install and manage JetBrains products, you can use shell scripts for launching your IDEs from the command line.

Toolbox App generates shell scripts automatically and places them to the following folders:

%LOCALAPPDATA%\JetBrains\Toolbox\scripts

By default, the Toolbox App puts shell scripts in a directory from the system PATH environment variable, so you can run the name of the script as a command to launch JetBrains Rider from any working directory.

Change shell scripts location

  1. Open the Toolbox App, click the Toolbox App menu icon in the top right corner, and select Settings.

    Toolbox App menu icon
  2. On the Settings tab, expand the Tools section, and specify another folder in the Shell scripts location field.

    Changing location of shell scripts

Rename shell scripts

If you have several versions of the same IDE, the Toolbox App generates a shell script for each version with a unique name. You can change the name of the shell script for an IDE instance in the settings for this specific instance.

  1. Open the Toolbox App.

  2. Click Tool actions next to an IDE instance and select Settings.

  3. At the bottom of the Configuration section, change the Shell script name field.

Toolbox App AppCode Settings
/usr/local/bin

or

~/Library/Application Support/JetBrains/Toolbox/scripts

By default, the Toolbox App puts shell scripts in a directory from the system PATH environment variable, so you can run the name of the script as a command to launch JetBrains Rider from any working directory.

Change shell scripts location

  1. Open the Toolbox App, click the Toolbox App menu icon in the top right corner, and select Settings.

    Toolbox App menu icon
  2. On the Settings tab, expand the Tools section, and specify another folder in the Shell scripts location field.

    Changing location of shell scripts

Rename shell scripts

If you have several versions of the same IDE, the Toolbox App generates a shell script for each version with a unique name. You can change the name of the shell script for an IDE instance in the settings for this specific instance.

  1. Open the Toolbox App.

  2. Click Tool actions next to an IDE instance and select Settings.

  3. At the bottom of the Configuration section, change the Shell script name field.

Toolbox App AppCode Settings
~/.local/share/JetBrains/Toolbox/scripts

By default, the Toolbox App puts shell scripts in a directory from the system PATH environment variable, so you can run the name of the script as a command to launch JetBrains Rider from any working directory.

Change shell scripts location

  1. Open the Toolbox App, click the Toolbox App menu icon in the top right corner, and select Settings.

    Toolbox App menu icon
  2. On the Settings tab, expand the Tools section, and specify another folder in the Shell scripts location field.

    Changing location of shell scripts

Rename shell scripts

If you have several versions of the same IDE, the Toolbox App generates a shell script for each version with a unique name. You can change the name of the shell script for an IDE instance in the settings for this specific instance.

  1. Open the Toolbox App.

  2. Click Tool actions next to an IDE instance and select Settings.

  3. At the bottom of the Configuration section, change the Shell script name field.

Toolbox App AppCode Settings

Command-line arguments

The launcher script accepts commands, options, and other arguments to modify its behavior. Without any arguments, the script launches JetBrains Rider. If you specify the path to a file or directory, JetBrains Rider will open the specified file or directory. For more information, refer to Open files from the command line.

Commands

diff

Open the diff viewer to see the differences between two specified files.

For more information, refer to Compare files from the command line.

merge

Open the Merge dialog to merge the specified files.

For more information, refer to Merge files from the command line.

attach-to-process

Start JetBrains Rider, open the specified solution, and create a new debugger session that will attach to the specified PID.

Syntax:

rider attach-to-process <pid> [<path-to-solution>]

Where:

  • pid — process id to attach to

  • path-to-solution — non-mandatory path to the solution that should be opened.

    You can specify either the path to the .sln file or just a directory.

    If not defined, then a new empty solution will be generated automatically. This may be helpful for projects without sources, when you just need to attach to some external process.

Options

nosplash

Do not show the splash screen when loading JetBrains Rider.

dontReopenProjects

Do not reopen projects and show the welcome screen. This can help if a project that was open crashes JetBrains Rider.

disableNonBundledPlugins

Do not load manually installed plugins. This can help if a plugin that you installed crashes JetBrains Rider. You will be able to start the IDE and either disable or uninstall the problematic plugin.

--wait

Wait for the files to be closed before returning to the command prompt.

Last modified: 10 April 2024