RustRover 2024.1 Help


RustRover includes an embedded terminal emulator for working with your command-line shell from inside the IDE. Use it to run Cargo commands, Git commands, set file permissions, and perform other command-line tasks without switching to a dedicated terminal application.

Enable the Terminal plugin

This functionality relies on the Terminal plugin, which is bundled and enabled in RustRover by default. If the relevant features aren't available, make sure that you didn't disable the plugin.

  1. Press Ctrl+Alt+S to open the IDE settings and then select Plugins.

  2. Open the Installed tab, find the Terminal plugin, and select the checkbox next to the plugin name.

Initially, the terminal emulator runs with your default system shell, but it supports many other shells, such as Windows PowerShell, Command Prompt cmd.exe, sh, bash, zsh, csh, and so on. For more information about changing the shell, refer to Terminal settings.

Open the Terminal tool window

  • Go to View | Tool Windows | Terminal or press Alt+F12.

    By default, the terminal emulator runs with the current directory set to the root directory of the current project. For more information about changing the default start directory, refer to Terminal settings.

  • Right-click any file (for example, in the Project tool window or any open editor tab) and select Open in Terminal to open the Terminal tool window with a new session in the directory of that file.

Start a new local session

  • To start a new session in a separate tab, click the Add button on the toolbar or press Ctrl+Shift+T.

    New session in the terminal

To run multiple sessions inside a tab, right-click the tab and select Split Right or Split Down in the context menu.

Splitting the terminal vertically (Split Right)

The Terminal saves tabs and sessions when you close the project or RustRover. It preserves tab names, the current working directory, and even the shell history.

To close a tab, click the Close button on the Terminal toolbar or press Ctrl+F4.

Press Alt+Right and Alt+Left to switch between active tabs. Alternatively, you can press Alt+Down to see the list of all terminal tabs.

To clear the terminal screen, press Ctrl+L.

Start a new SSH session

  1. On the toolbar, click Start a new SSH session and select New SSH Session.

    Starting a new SSH session from the Terminal
  2. Enter the address of the host to which you want to connect, and provide authentication data.

    Providing data in the SSH Session dialog

    Or, if you have configured SSH configurations, you can select one of them from the list.

Start a new SSH session

To terminate the connection, click Terminate session in the terminal tab.

Rename terminal tab

  • Right-click the tab and select Rename Session from the context menu.

  • To search for a certain string in a Terminal session, press Ctrl+F. This searches all text in the session: the prompt, commands, and output.

    Searching in the Terminal

By default, the search is not case-sensitive. You can click the Match Case icon Match case in the search field to make it case-sensitive.

Configure the terminal emulator

  • Press Ctrl+Alt+S to open the IDE settings and then select Tools | Terminal.

  • Alternatively, click on the Terminal toolbar and select Settings.

For more information, refer to Terminal settings.

New Terminal

Starting with the 2024.1 release, a beta version of the new terminal is available in RustRover.

Along with its improved look and feel, other major features include:

  • Separation of command output into distinct visual blocks. Press Ctrl+Up to navigate to the output area and Ctrl+Down to switch to the input area. Use the Up and Down arrow keys to navigate the output area blocks.

  • Command completion, including completion for command names, arguments, flags, and paths. For each suggested value, the new terminal displays quick documentation.

    New Terminal tool window

    Completion for command names and arguments is available as you type them, but you can also press Ctrl+Space or Tab after a command name to get the list of possible arguments.

    To display the history of commands that you have previously entered, press Up in the input area.

Enable New Terminal

  1. Open the Terminal tool window: Tools | Tool Windows | Terminal.

  2. In the tool window header, click Options and select Enable New Terminal.

Enable New Terminal

Alternatively, open the IDE settings (Ctrl+Alt+S) and go to Tools | Terminal | Enable New Terminal.

Search in output blocks

While the full text buffer remains searchable, the new terminal also enables searching within specific output blocks.

  1. In the Terminal tool window, press Ctrl+F.

  2. In the search dialog than opens, click Search in blocks (Search in block) and type the keyword you are looking for.

This narrows the search to only the output block that is currently selected. You can click any block to select it or use the Up and Down arrow keys to navigate them.

Search in New Terminal

Terminal settings

Settings | Tools | Terminal

Project Settings

These settings affect the terminal only for the current project:

Start directory

Specify the working directory where every new shell session should start. By default, it starts in the root directory of the current project.

Environment variables

Specify custom environment variables for every new shell session.

Application Settings

These settings affect the terminal in any project that you open with the current RustRover instance:

Shell path

Specify the shell that will run by default. RustRover should automatically detect the default shell based on your environment. Here are some examples of different shells:

  • Bash: /bin/bash

  • Z shell: /bin/zsh

  • Bash for Windows: bash.exe

  • WSL: wsl.exe

  • PowerShell: powershell

  • Command Prompt: cmd.exe

  • Cygwin: "C:\cygwin\bin\bash.exe" --login -i

Default Tab name

Specify the default name for new tabs.

Audible bell

Play the bell sound on various events.

Close session when it ends

Close the current session when the corresponding process ends (for example, by kill).

Mouse reporting

Enable the mouse pointer support in the embedded local terminal.

Copy to clipboard on selection

Copy text selected in the terminal to the clipboard.

Paste on middle mouse button click

Paste clipboard contents by clicking the middle mouse button.

Override IDE shortcuts

Use shell-specific shortcuts instead of IDE shortcuts when the Terminal tool window is active.

Click Configure terminal keybindings to open the settings page and configure the shortcuts that are available in the Terminal tool window under Plugins | Terminal. For example, Switch Focus to Editor is mapped to Escape by default, which means that if you don't override the IDE shortcuts, Escape will switch focus from the terminal to the editor.

Shell integration

Integrate the terminal with the system shell to properly keep track of your command history for sessions and load a custom config file with required environment variables.

Shell integration works for sh, bash, zsh, and fish shells.

Highlight hyperlinks

Highlight HTTP links in the terminal and make them clickable.

Use Option as Meta key

On macOS, use the Option key as the Meta key.

Run Commands using IDE

Detect and highlight commands that can be used as IDE features instead of running them in the terminal and reading console output.

When enabled, instead of pressing Enter, which runs the command in the terminal, press Ctrl+Enter to open the corresponding GUI element.

Cursor shape

Select the shape of the cursor: block, underline, or vertical.

The embedded terminal emulator also inherits the following IDE settings:

  • On the Keymap settings page, you can configure the copy Ctrl+C and paste Ctrl+V shortcuts.

  • On the Editor | General | Appearance page, you can configure blinking frequency for the caret. The Terminal does not inherit the Use block caret option because there is a separate option for that: Cursor shape.

  • On the Editor | Color Scheme | Console Font page, you can configure line spacing and fonts.

  • On the Editor | Color Scheme | Console Colors page, you can configure font colors.

  • On the Editor | Color Scheme | General page, you can configure the selection foreground and background colors.

Last modified: 30 April 2024