DataGrip 2024.3 Help

External tools

Configure third-party command-line applications as external tools to run them from DataGrip. 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, DataGrip 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, DataGrip will print the tool's output to the console.

Add a local external tool

This example demonstrates how to add OptiPNG as an external tool and use it to optimize images in your project.

  1. Press Ctrl+Alt+S to open settings and then select Tools | External Tools.

  2. Click the Add button and specify the tool's settings.

    The Create Tool dialog

    For more information, refer to External Tools.

    In our case, OptiPNG will be run with the -o4 $FilePath$ arguments. You can use macros that can refer to the project name, the current file path, a path to the PHP executable, and so on. Clicking the Insert Macros icon will open the Macros dialog that lists all available macros and their values.

  3. 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:

  • Go to Tools | External Tools | Optimize PNG.

  • Right-click a file in the Files tool window and select External Tools | Optimize PNG from the context menu.

    Run External tool
  • Create a shortcut to run the tool.

    Press Ctrl+Alt+S to open settings and then select Keymap. Find the Optimize PNG action under the External Tools node, and assign a shortcut for it.

    Create a shortcut for an external tool

When you run the tool, the output is displayed in the Run tool window.

Run the added tool on a remote server

Do one of the following:

  • In the main menu, go to Tools | Remote Tools and the name of the added remote external tool.

  • Create a shortcut to run the tool.

    Press Ctrl+Alt+S to open settings and then select Keymap. 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, DataGrip will connect to the server via SSH and run the date command, returning the output to the Run tool window in DataGrip.

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:

  • Right-click the file in the Project tool window and select Open in Browser.

  • In the main menu, go to View | Open in Browser.

  • Use the browser popup in the top right part of the editor window (appears on hover). Click the browser button to open the web server file URL, or Shift+Click it to open the local file URL.

    Show in browser

The Open in Browser action is not available for other file types. However, you can still execute it using Find Action Ctrl+Shift+A.

View and configure the list of browsers

  • In the Settings dialog (Ctrl+Alt+S) , select Tools | Web Browsers and Preview.

The Web Browsers page in Settings

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.

  1. In the Settings dialog (Ctrl+Alt+S) , select Tools | Web Browsers and Preview.

  2. Select the browser in the list and click the Edit button.

    • For Firefox, specify the path to the profiles.ini file and choose the profile to use. For more information, refer to 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 DataGrip. For more information, open chrome://flags in the Chrome address bar.

Last modified: 11 October 2024