# Teamscale Integration for Visual Studio

Before installing the Teamscale Integration for Visual Studio, make sure its system requirements are met.

# Download & Installation

You can download the Teamscale Visual Studio plugin by using the integrated extension manager in Visual Studio by searching for Teamscale or by downloading the Plugin from the Visual Studio Gallery.


The plugin is compatible with Visual Studio versions 2015 to 2019.

Installation via the extension manager has the benefit of automatic update notifications, as they get published.

# Manual Installation

In case you downloaded the extension manually you can install it as follows:

  1. Double click the Teamscale.vsix extension file.
  2. In the VSIX Installer dialog, click Install.
  3. Restart Visual Studio.

# Configuring a Teamscale Server

In Visual Studio, you need to configure your Teamscale server, so that the plugin knows where to fetch findings.

  1. Click Tools > Teamscale Options...

  2. Click Add.

  3. In the dialog, enter a Name for your server (this name is later referenced from project mappings), the server URL, and your Username and Access Key.

    Visual Studio Server Settings

  4. Click Save. The dialog should close, if validation of the connection was successful.

# Configuring the Project Mapping

Next, you have to specify a project mapping, so that the plugin knows which Teamscale project belongs to which code on the hard drive.

  1. Click Tools > Teamscale Options...

  2. On the left hand side select Teamscale > Project Mapping.

  3. Click Add.

  4. In the dialog, select the Server and Teamscale Project. If branch analysis is enabled for the project, select the relevant branch in the combo box (defaults to the default branch configured in Teamscale). Choose the local folder you want to map to the project and, optionally, specify a sub-path of the project on the server (can remain blank in most cases).

    Visual Studio Project Settings

  5. Click Save.

# Inspecting Findings

After the previous steps have been completed successfully you should now be able to explore findings in your code.

  1. Findings in the opened document should be marked with a red bar on the left margin.
  2. Hovering with the mouse over the margin will show a tooltip containing the description of the finding.
  3. To show all findings of a file, either right click in the current editor or the Solution Explorer and select Teamscale > Show Findings.
  4. In the findings list, one can double click to jump to the finding in the code, open it in the browser, or blacklist the finding as shown in the screenshot below.

Visual Studio Findings View

# Troubleshooting

Problems with the Visual Studio integration can be troubleshooted by enabling logging.

  1. Start Visual Studio with the /log command-line switch: devenv.exe /log vslog.xml
  2. Reproduce the error
  3. Errors will be logged in vslog.xml

If you did not specify a log file, the default one located at %APPDATA%\Microsoft\VisualStudio\<Version>\ActivityLog.xml will be used.