RubyMine 2019.1 Help

Configuring Remote Interpreters using WSL

This document describes how to use a Ruby interpreter installed on Windows using WSL. The following Linux distributions are supported:

Perform the following steps to configure an interpreter:

  1. Open the Settings/Preferences dialog (Ctrl+Alt+S), go to the Language & Frameworks | Ruby SDK and Gems page.

  2. Click the Add icon and select New remote… in the drop-down:

    New remote

  3. In the invoked dialog, select WSL:

    Configure Remote Ruby Interpreter

    Choose the desired Linux distribution.

    In Ruby or version manager path, specify the path to the Ruby interpreter or the version manager executable. Click OK.

  4. (Optional) If you specified a path to the version manager executable in the previous dialog, RubyMine suggests you select the Ruby interpreter used to run a remote application:

    Select Distribution

  5. Select the added SDK in the Ruby SDK and Gems page:

    Ruby SDK and Gems page
  6. (Optional) If you want to use the added SDK to debug a remote process, specify mappings between files of a local and remote project. To do this, click the Edit Path Mappings Edit Path Mappings button. In the Edit Project Path Mappings dialog, specify the local and remote project root paths:

    Edit Project Path Mappings

Custom WSL distributions

RubyMine allows you to use custom Linux distributions run on WSL. This can be done by editing the wsl.distributions.xml configuration file created by RubyMine automatically after detecting WSL. To add a custom distribution, do the following:

  1. Open the %\HOMEPATH%\.RubyMine2019.1\config\options\wsl.distributions.xml file.

  2. Add the descriptor element and provide settings to access your custom distribution. Note that the id value should be unique. For example:

    <!-- ... --> <descriptor> <id>DEBIAN_CUSTOM</id> <!-- ... --> <executable-path>debian-custom.exe</executable-path> <presentable-name>Debian GNU/Linux - Custom</presentable-name> </descriptor> <!-- ... -->
  3. Restart RubyMine and add your custom distribution as a remote interpreter as described above.

    Configure Remote Ruby Interpreter
Last modified: 8 May 2019