RustRover 2024.1 Help

Command-line interface

Use RustRover 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 RustRover, formatting the source code, and running inspections. To use them from the Command Prompt cmd.exe, add the location of the RustRover bin folder to the PATH environment variable. For example, if you installed RustRover to C:\Program Files\JetBrains\RustRover, you can use the following command:

set PATH=%PATH%;C:\Program Files\JetBrains\RustRover\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\RustRover\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:

rustrover.exe

Alternatively, you can use the batch script:

rustrover.bat

To run RustRover 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 RustRover.app with the following command:

open -na "RustRover.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/rustrover with the following contents:

#!/bin/sh open -na "RustRover.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 rustrover from anywhere in the shell.

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

chmod +x /usr/local/bin/rustrover

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

/opt/rust/bin/rustrover.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 rust in /usr/local/bin, run the following command:

ln -s /opt/rust/bin/rustrover.sh /usr/local/bin/rust

Since /usr/local/bin should be in the PATH environment variable by default, you should be able to run the rust 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 RustRover 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 Rust IDE 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 RustRover 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 Rust IDE 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 RustRover 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 Rust IDE Settings

Command-line arguments

The launcher script accepts commands, options, and other arguments to modify its behavior. Without any arguments, the script launches RustRover. If you specify the path to a file or directory, RustRover will open the specified file or directory.

Commands

diff

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

merge

Open the Merge dialog to merge the specified files.

format

Apply code style formatting to the specified files.

inspect

Perform code inspection on the specified project.

installPlugins

Install plugins by plugin ID from the JetBrains Marketplace or a custom plugin repository.

Options

nosplash

Do not show the splash screen when loading RustRover.

dontReopenProjects

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

disableNonBundledPlugins

Launch RustRover without loading manually installed plugins. This option doesn't remove or permanently disable plugins. This can help if a plugin that you installed crashes RustRover. 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.

For example, you can open file.txt with the following command:

rust --wait file.txt

The shell will be waiting until file.txt is closed.

Last modified: 16 April 2024