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

Name

The name of the tool that appears as a command name in the Tools menu and the context menus.

Group

The group the tool belongs to. The tool groups correspond to submenus in the Tools menu and the context menus.

Select an existing group from the list.

To create a new group, type its name in the list.

Description

The tool description (optional).

Tool Settings

Program

The path to the executable file to be run. Click to select the file or to open the Macros dialog to select a macro.

Built-in IDE macros are resolved at runtime and let you specify paths relevant to the current context, such as the currently selected file, your project source path, and so on.

Arguments

The arguments to be passed to the program the way you'd specify them on the command line. Click to open the Macros dialog to select a macro.

When specifying the arguments, follow these rules:

• Note that external tools provide the absolute path of the files, not project-directory-relative ones.

• Use spaces to separate individual arguments.

• If an argument includes spaces, enclose the spaces or the argument that contains the spaces in double quotes, for example, some" "arg or "some arg".

• If an argument includes double quotes (for example as part of the argument), escape the double quotes by means of the backslashes, for example, -Dmy.prop=\"quoted_value\".

Working directory

The path to the current working directory for the program. Click to select the directory, or to open the Macros dialog to select a macro.

Advanced Options

Synchronize files after execution

Make PyCharm aware of changes in the file system when the tool completes its execution.

Open console for tool output

Open the console for viewing the tool output such error messages, etc.

Make console active on message in stdout

Make the output console active and bring it forward when the corresponding event occurs.

Make console active on message in stderr

The same as the previous option but for stderr.

Output Filters

The output filters are used to turn absolute file paths and line numbers in the tool output into hyperlinks. You'll be able to use those links to open the corresponding files in the editor. You can specify one or several filters. Each line is a regular expression. You can use the following macros: $FILE_PATH$, $LINE$, and $COLUMN$. For example:

For more information, see Built-in IDE macros.

Connection settings

In this section, appoint a remote Web server or the default remote interpreter to access through the SSH terminal and specify where the connection settings should be taken from:

• Current Vagrant: select this option to have the commands in the SSH Terminal executed on the currently running Vagrant virtual machine.

• Default remote interpreter: select this option to have commands in the SSH terminal executed on the same host, where the default remote interpreter runs.

• SSH configuration: select this option to have the commands in the SSH Terminal executed on the local or remote Web server accessible through one of the SSH configurations.

  • Select SSH configuration on every run: if this option is selected, you will have to choose the desired configuration from the popup, every time you choose Tools | Start SSH Session from the main menu.

  • If the desired SSH configuration does not appear in the list, click the Set up configurations link, and define one in the SSH Configurations page.