External tools
Configure third-party command-line applications as external tools to run them from RubyMine. For example, your workflow may require running a specific script, code generator, analyzer, preprocessor or postprocessor, some database utility, and so on. By configuring it as an external tool, RubyMine provides a dedicated action for it, which you can run from the main menu, from certain context menus, assign a shortcut to it, or run it when launching a specific run configuration.
You can use built-in IDE macros to pass context-dependent command-line arguments to the tool, such as the current file or your project source path. If necessary, RubyMine will print the tool's output to the console.
RubyMine supports the following types of external tools:
Local tools run locally on your computer.
Remote tools are executed on a remote server over SSH.
Add a local external tool
Many image editors create non-optimized png images. To optimize images, you can use the OptiPNG command-line tool. Let's set it up for use in RubyMine.
Press Control+Alt+S to open the IDE settings and select .
Click
and specify the tool's settings.
For more information, see External Tools.
Click OK to add the tool and then apply the changes.
Run the added local external tool
To open the selected file in the newly added toolimage, do one of the following:
From the main menu, select .
Right-click a file in the Project tool window and select from the context menu.
Create a shortcut to run the tool.
Press Control+Alt+S to open the IDE settings and select . Find the Optimize PNG action under the External Tools node, and assign a shortcut for it.
When you run the tool, the output is displayed in the Run tool window.
Add a remote external tool
Remote SSH external tools are configured similarly to local external tools, but also define the remote server on which they are executed and require credentials for connecting to it via SSH.
This example demonstrates how to add date as a remote SSH external tool that is executed on a remote server over SSH and returns the current date and time on it.
Press Control+Alt+S to open the IDE settings and select .
Click
to open the Create Tool dialog.
This dialog provides the same set of settings as when you add a local external tool, but also allows you to select a remote connection. If you don't specify the connection settings, RubyMine will ask you for the host, port, and relevant SSH credentials every time you run the tool on the server. For more information, see Remote SSH External Tools.
Click OK to add the tool and then apply the changes.
Run the added tool on a remote server
Do one of the following:
From the main menu, select and the name of the added remote external tool.
Create a shortcut to run the tool.
Press Control+Alt+S to open the IDE settings and select . Find the action with the name of your configured remote external tool, and assign a shortcut for it.
After you specify the host, port, and credentials, RubyMine will connect to the server via SSH and run the date command, returning the output to the Run tool window in RubyMine.
Web browsers
You can use a web browser to open any file from your project. By default, it is used to preview the output of an HTML file or run and debug web applications.
Open a file in a web browser
To open a file that is intended to be rendered by a web browser (HTML, XML, JSP, and so on), do one of the following:
Press Alt+F2.
Right-click a file and select Open in Browser.
From the main menu, select View | Open in Browser.
Use the browser popup in the top right part of the editor window. Click the browser button to open the web server file URL, or Shift+LeftClick it to open the local file URL.
The Open in Browser action is not available for other file types. However, you can still execute it using Find Action Control+Shift+A.
View and configure the list of browsers
In the Settings dialog (Control+Alt+S), select Tools | Web Browsers and Preview.
If a browser was installed using a standard procedure, the alias in the Path field should point to the right location. If it does not, specify the path to the corresponding executable file.
Use custom profile and settings
You can configure custom profiles for Firefox and Chrome family browsers.
In the Settings dialog (Control+Alt+S), select Tools | Web Browsers and Preview.
Select the browser in the list and click
.For Firefox, specify the path to the profiles.ini file and choose the profile to use. For more information, see Firefox browser profile.
For Chrome, select Use custom user data directory and specify the location of the user data directory.
You can also specify additional command-line options to use when running Chrome from RubyMine. For more information, open
chrome://flagsin the Chrome address bar.