TeamCity 2020.2 Help

Installing Agent Tools

In TeamCity an agent tool (i.e. a set of files/a binary distribution) is a type of plugin without any classes loaded into the runtime; agent tools are used only to distribute binary files to agents.

TeamCity allows you to install/remove additional tools on the server and distribute them to build agents on-demand.
In environments with many build agents you can centralize distribution of configuration files (for example, if you want to distribute a custom configuration file/library to all agents that require it) or remove a tool on agents at once.

The Administration | Tools page provides a unified interface to set up tools to be used by appropriate plugins. You can install different versions of a tool and/or change the default one. The tools will be automatically distributed to build agents that request them and used in the related runners.

The following types of tools can be managed up via the Administration | Tools page:

  • IntelliJ Inspections and Duplicates Engine with the bundled version of IntelliJ IDEA set as default.

  • JetBrains dotCover Command Line Tools with the bundled version set as default. Used to collect code coverage for your .NET project.

  • JetBrains ReSharper Command Line Tools: by default the tools are bundled with TeamCity and are used by Inspections (.NET), Duplicates Finder (.NET) build runners to run code analysis.

  • Maven: several bundled versions are displayed, with 3.2.5 set as default.

  • NuGet.exe used in NuGet specific build steps and NuGet Dependency Trigger. NuGet packages (.nupkg files) with the tools/NuGet.exe file inside are supported.

  • NUnit 3: different versions can be installed and the default version set/changed.

  • Sysinternals handle.exe used to determine processes which hold files in the checkout directory on Windows agents.

  • Sysinternals psexec.exe required for installing a TeamCity agent from a Windows server to a Windows host using Agent push.

  • You can also upload your own tool as a .zip archive: the structure of the tool plugin is described on the Plugins Packaging page. TeamCity will use the name of the zip file as the tool name on all agents. The zip file will be automatically unpacked on the agents to the directory with the same name.
    When the first custom tool is installed, the Zip Archive section appears on the page. In this section, you can see all the tool usages, remove the tool, or install a new one.

TeamCity places installed tools into the <TeamCity Data Directory>/plugins/.tools and monitors the content of this folder.

An agent downloads a tool before starting the first build which requires it. Once downloaded, the tool is stored on the agent so builds don't spend time on downloading it again.

When editing settings of a build step that directly depends on a tool, you just need to select a specific version of this tool from the drop-down menu to let TeamCity know what exact tool should be delivered to an agent.

However, there are cases when an arbitrary build script needs a certain tool. In such case, you can reference a required tool via a %teamcity.tool.<installed_tool_ID>% parameter in the build step settings that support the input of parameters. You can also reference a tool in values of build configuration parameters or in agent requirements. For instance, in case with agent requirements, you can define a requirement of the type exists for a parameter with the name %teamcity.tool.<installed_tool_ID>%, and this will instruct TeamCity that the build requires the referenced tool. Before starting a build, the TeamCity server scans all build steps' settings, finds all such tool references, and informs an agent what tools are required for the build.

To check that the tool appears on the agent, look for teamcity.tool.<installed_tool_ID> in configuration parameters reported by the agent in the TeamCity web UI.

If you delete a tool in the TeamCity web UI, each agent that have this tool installed will detect this, delete own copy of the tool, and restart.

Last modified: 23 July 2020