IntelliJ IDEA 14.0.0 Web Help

Create/Copy/Edit Tool Dialog (Remote SSH External Tools)

File | Settings | External ToolsCtrl+Alt+S settings

The dialog box opens when you click the add, copy, or edit1 buttons in the Remote SSH External Tools dialog box.

Use this dialog box to enable using a specific remote SSH external tool from IntelliJ IDEA, specify the menus to access it from, define where to display the tool's output, and configure the filters to distinguish it from other output. Based on these filters, IntelliJ IDEA displays paths to the tool's output files as links. When you click such link, the corresponding file is opened in the editor.

Item Description
Name In this text box, specify the name to identify the tool in the IntelliJ IDEA menus.
Group Use this drop-down list to specify the group the current tool belong to. Type a new name or select an existing group from the list.
Description In this text box, provide an optional description of the tool.
Options In this section, specify the following options:
  • Synchronize files after execution: When this check box is selected, IntelliJ IDEA detects all externally changed files and reloads them from a disk on completing tool execution.
  • Open console: Select this check box to have IntelliJ IDEA open a console to display output of the configured external tool.

    When this check box is selected, you can opt to display output of stderr and stdout:

Show console when standard out changes Select this check box to activate output console and bring it forward, if associated process writes to Standard.out.
Show console when standard error changes Select this check box to activate output console and bring it forward, if associated process writes to Standard.err.
Output Filters Click this button to open the Output Filters dialog box where you can define the filters to distinguish the output of the external tool from other output. Based on these filters, IntelliJ IDEA displays output file paths in output messages as links. When you click such link, the corresponding file is opened in the editor.
Show In In this area, specify the menus the tool should be available from. The available options are:
  • Main menu - select this check box to have the tool command added to the Tools menu.
  • Editor menu - select this check box to have the tool command added to the context menu of the Editor.
  • Project views - select this check box to have the tool command added to the context menu of the Project tool window.
  • Search results - select this check box to have the tool command added to the context menu of the Search Results area in the Find tool window.
Connection settings In this section, appoint the destination_environment to access through the SSH terminal and specify where the connection settings should be taken from:
  1. Current Vagrant: select this option to have the commands in the SSH Terminal executed on the currently running Vagrant virtual machine. For details, see Working with Reproducible Development Environments Using Vagrant.
  2. Deployment server: select this option to have the commands in the SSH Terminal executed on the local or remote Web server accessible through one of the server access configurations. From the drop-down list, choose the server access configuration that specifies the destination environment and the settings to establish connection to it.
    • Select server on every run: if this option is selected, you will have to choose the desired server access configuration from the pop-up window, every time you choose Tools | Start SSH Session on the main menu.
    • If the desired server access configuration does not appear in the drop-down list, click the link Configure Servers, and define one in the Deployment page. For details, see Configuring Synchronization with a Web Server.
Tool Settings In this area, specify the following options:
  • Program: Use this field to specify the location of the external tool's executable file in one of the following ways:
    • Type the path explicitly in the text box.
    • Click the Browse button browseButton to open the Select Path dialog box and navigate to the desired location.
    • Click the Insert Macro button to open the Macros dialog box where you can select the desired macro from the list.
  • Parameters: Use this field to define the parameters of the external tool in one of the following ways:
    • Type the list of parameters in the text box.
    • Click the Insert Macro button to open the Macros dialog box where you can select the desired macro from the list.

    When specifying the parameters, follow these rules:

    • Use spaces to separate individual parameters.
    • If a parameter includes spaces, enclose the spaces or the argument that contains the spaces in double quotes, for example, some" "arg or "some arg".
    • If a parameter includes double quotes (e.g. as part of the argument), escape the double quotes by means of the backslashes, for example, -Dmy.prop=\"quoted_value\".
  • Working directory: Use this field to define the working directory of the external tool in one of the following ways:
    • Type the path explicitly in the text box.
    • Click the Browse button browseButton to open the Select Path dialog box and navigate to the desired location.
    • Click the Insert Macro button to open the Macros dialog box, where you can select the desired macro from the list.

See Also

Last modified: 4 December 2014
comments powered by Disqus