RubyMine 2020.3 Help

Manage plugins

Plugins extend the core functionality of RubyMine. They:

  • provide integration with version control systems, application servers, and other tools

  • add coding assistance support for various languages and frameworks

  • boost your productivity with shortcut hints, live previews, File Watchers, and so on

  • help you learn a new programming language with coding exercises and verification

Open plugin settings

  • In the Settings/Preferences dialog Ctrl+Alt+S, select Plugins.

The Plugins settings dialog

Use the Marketplace tab to browse and install plugins from the JetBrains Plugin Repository or from a custom plugin repository.

Use the Installed tab to browse installed plugins, enable, disable, update, or remove them. Disabling unnecessary plugins can increase performance.

Most plugins can be used with any JetBrains product. Some are limited only to commercial products. There are also plugins that require a separate license.

If a plugin depends on some other plugin, RubyMine will notify you about the dependencies. If your project depends on certain plugins, add them to the list of required plugins.

If existing plugins do not provide some functionality that you need, you can create your own plugin for RubyMine. For more information, see Develop your own plugins.

By default, RubyMine includes a number of bundled plugins. You can disable bundled plugins, but they cannot be removed. You can install additional plugins from the plugin repository or from a local archive file (ZIP or JAR).

Install plugin from repository

  1. In the Settings/Preferences dialog Ctrl+Alt+S, select Plugins.

  2. Find the plugin in the Marketplace and click Install.

To install a specific version, go to the plugin page in the JetBrains Plugin Repository, download and install it as described in Install plugin from disk. For example, you can do it if the most recent version of the plugin is broken.

Install plugin from disk

After you download the plugin archive (ZIP or JAR), do the following:

  1. In the Settings/Preferences dialog Ctrl+Alt+S, select Plugins.

  2. On the Plugins page, click The Settings button and then click Install Plugin from Disk.

  3. Select the plugin archive file and click OK.

  4. Click OK to apply the changes and restart the IDE if prompted.

Remove plugin

You cannot remove bundled plugins.

  1. In the Settings/Preferences dialog Ctrl+Alt+S, select Plugins.

  2. Open the Installed tab and find the plugin that you want to remove.

  3. Click The down arrow next to the Disable/ Enable button and select Uninstall from the drop-down menu.

    The Uninstall item for plugins

Disable plugin

You can disable a plugin without removing it if you do not need the corresponding functionality.

  1. In the Settings/Preferences dialog Ctrl+Alt+S, select Plugins.

  2. Open the Installed tab, find and select the plugin that you want to disable.

  3. Click Disable. The button will change to Enable.

    Alternatively, you can use the checkboxes in the list of plugins or the Disable All buttons for plugin categories.

You can disable or enable all manually installed plugins at once (non-bundled) in the menu under The Settings button.

Disable all downloaded plugins

Custom plugin repositories

By default, RubyMine is configured to use plugins from the JetBrains Plugin Repository. This is where all the community plugins are hosted, and you are free to host your plugins there. However, if you develop plugins for internal use only, you can set up a custom plugin repository for them.

For information about setting up a custom plugin repository, see the IntelliJ Platform SDK documentation.

Once you set up your plugin repository, add it to RubyMine:

  1. In the Settings/Preferences dialog Ctrl+Alt+S, select Plugins.

  2. On the Plugins page, click The cogwheel icon and then click Manage Plugin Repositories.

  3. In the Custom Plugin Repositories dialog, click The Add icon and specify your repository URL. It must point to the location of the updatePlugins.xml file. The file can be on the same server as your custom plugins, or on a dedicated one.

    How to add a custom plugin repository
  4. Click OK in the Custom Plugin Repositories dialog to save the list of plugin repositories.

  5. Click OK in the Settings/Preferences dialog to apply the changes.

To browse the custom plugin repository, type repository: followed by the URL of the repository in the Marketplace tab of the Plugins page. For example:

repository: myPlugin

Alternatively, you can replace the default JetBrains Plugin Repository with your custom repository URL. This can be helpful if you want only your custom repository plugins to be available from RubyMine. To do this, edit the platform properties or VM options file as described below. For more information, see Advanced configuration.

Use a custom plugin repository

  1. From the main menu, select Help | Edit Custom Properties.

  2. Add the property to the platform properties file . For example:""

    Make sure that there is no URL.

  3. Restart RubyMine.

If you replace the default plugin repository with a custom one, the search field on the Marketplace tab of the Plugins dialog will browse only the plugins in your custom repository.

Required plugins

A project may require plugins that provide support for certain technologies or frameworks. You can add such plugins to the list of required plugins for the current project, so that RubyMine will verify that the plugins are installed and enabled. It will notify you if you forget about some plugin, or someone on your team is not aware about the dependency as they work on the project.

Add a required plugin for your current project

  1. Make sure that the required plugin is installed.

  2. In the Settings/Preferences dialog Ctrl+Alt+S, select Build, Execution, Deployment | Required Plugins.

  3. On the Required Plugins page, click The Add icon and select the plugin. Optionally, specify the minimum and maximum version of the plugin.

    Add required plugin dialog

After the required plugin is added, when you open the project in RubyMine, it will notify you if the plugin is disabled, not installed, or requires an update.

Required plugin is disabled

Click the link in the notification message to quickly enable, install, or update the required plugin.

Develop your own plugins

You can use any edition of RubyMine to develop plugins. It provides an open API, a dedicated SDK, module, and run/debug configurations to help you.

The recommended workflow is to use Gradle. The old workflow using the internal RubyMine build system is also supported. For more information, see the IntelliJ Platform SDK Developer Guide.

Last modified: 06 April 2021