WebStorm 2020.2 Help

Services tool window

The Services tool window includes various services that help you during software development: run/debug configurations, application servers, database sessions, Docker connections, and so on. Plugin developers can add other services through the IntelliJ platform API.

Main toolbar

The main toolbar contains the following buttons and menus that are common for all service types:

IconActionDescription
The Expand All buttonExpand All Ctrl+NumPad +Expand all items in the list.
The Collapse All buttonCollapse All Ctrl+NumPad -Collapse all items in the list.
The Group By menuGroup By

Choose how you want to organize the list of services.

The Filter menuFilterChoose how you want to filter the list of services.
The Open in New Tab buttonOpen in New TabMove the selected items to a separate tab.
The Add Service menuAdd Service Alt+InsertChoose a service type to add.

Run/debug configurations

Run/debug configurations are not listed in the Services tool window by default. You need to explicitly specify the types of configurations you want to be available and create the corresponding configurations.

Add the types of configurations to show in the Services tool window

  1. From the main menu, select Run | Edit Configurations or use the selector on the toolbar.

    Selecting a run/debug configuration

  2. In the Run/Debug Configurations dialog, select Templates from the list on the left.

  3. In the right-hand pane, expand the Configurations available in Services section.

  4. Click the Add button in the Configurations available in Services section and select the necessary run configuration type.

    You can add or remove multiple configuration types one by one.

    Enabling the Services tool window

    Note that the tool window will only display the configuration types for which you have created one or more configurations.

    Thus, if you add a configuration type for which no configurations exist in the project, this type will not be displayed in the tool window until you create a configuration of this type.

Buttons on the toolbar depend on the selected type of the run/debug configuration.

IconActionDescription
The Run buttonRun Ctrl+Shift+F10Run the selected configuration.
The Debug buttonDebug Ctrl+Shift+DDebug the selected configuration.
The Stop buttonStop Ctrl+F2Stop the selected configuration.

Docker

This type of service is available if you have configured connection settings for at least one Docker instance. For more information, seeEnable Docker support.

Add a Docker connection

  1. Click the New Service menu and select Docker Connection.

  2. Configure the docker connection settings in the New Docker Connection dialog.

Main Docker node

IconActionDescription
The Connect buttonConnectConnect to the Docker daemon and list all available images and containers.
The Disconnect buttonDisconnectDisconnect from the Docker daemon.
The Edit Configuration buttonEdit ConfigurationEdit the Docker connection settings.
The Deploy buttonDeploy Select an existing Docker run configuration or create a new one. For more information, see Running containers
The Pull Image buttonPull Image Pull an image from a Docker registry. For more information, seePull an image from a Docker registry.
The Filter buttonFilterChoose whether you want to show or hide containers that are not running and images with no tags.

Containers

IconActionDescription
The Start Container buttonStart ContainerRun the selected container.
The Stop Container buttonStop ContainerStop the selected container.
The Delete Container buttonDelete ContainerDelete the selected container.
The Filter buttonFilterChoose whether you want to show or hide containers that are not running and images with no tags.

Images

IconActionDescription
The Pull Image buttonPull Image Pull an image from a Docker registry. For more information, seePull an image from a Docker registry.
The Create Container buttonCreate ContainerCreate a Docker container from the selected image.
The Delete Image buttonDelete ImageRemove the selected image.
The Push Image buttonPush Image Push an image to a Docker registry. For more information, seePush an image to a Docker registry.
The Filter buttonFilterChoose whether you want to show or hide containers that are not running and images with no tags.

Main Docker Compose node

IconActionDescription
The Deploy buttonDeploy Deploy your selected Docker Compose services using the associated run/debug configuration. For more information, see Docker Compose
The Stop buttonStopStop all containers in the selected Docker Compose services.
The Down buttonDownStop and remove all containers in the selected Docker Compose services, including all related networks, volumes, and images.
The Edit Configuration buttonEdit ConfigurationEdit the selected Docker Compose run configuration.
The Filter buttonFilterChoose whether you want to show or hide containers that are not running and images with no tags.

Docker Compose services

IconActionDescription
The Start buttonStartStart all containers for the selected service.
The Stop buttonStopStop all containers for the selected service.
The Scale buttonScaleChange the number of containers for the selected service.
The Delete Container buttonDelete ContainerDelete the selected container.
The Filter buttonFilterChoose whether you want to show or hide containers that are not running and images with no tags.

Productivity tips

Use tabs

The Services tool window can include a lot of services, which you can group according to their type or create separate tabs for your own custom grouping. For example, you can create a tab that will include the following: the run configuration for the application that you are developing, the Docker container that runs the database used as a backend for your application, and a console for accessing the database.

Hide the services tree

Click The Show Options Menu button in the right part of the Services tool window toolbar and then click Show Services Tree to remove the checkbox. You can also press Ctrl+Shift+T to toggle the services tree.

If you hide the services tree, it is replaced by a services navigation bar. Press Alt+Home to focus the services navigation bar.

Hide, remove, and delete services

Right-click any service and select Delete Delete to completely remove the corresponding run configuration, cloud provider, Docker connection, and so on.

If you don't want to show run/debug configurations of a certain type in the Services tool window, right-click the corresponding configuration and select Remove Configuration Type from Services. This will not remove the actual configuration.

To hide a specific run configuration from the Services tool window, right-click the corresponding configuration and select Hide Configuration. To see all hidden run configurations, click the Add Service menu and select Restore Hidden Configurations.

Last modified: 21 September 2020