Installation & Setup

Installation options have been changed in SpecSync v3. For older releases check the Older versions reference page.

SpecSync for Azure DevOps can be installed in different ways depending on the project context. The following table contains an overview of the installation options. The detailed installation instructions can be found by clicking the name of the option.

Option	Supported Platforms	Prerequisites	Notes
.NET tool (NuGet, Download)	Windows, Linux, macOS, Docker	.NET Core 3.1 SDK or later (including .NET 6, 7, 8, 9)	Recommended
.NET Console App (NuGet, Download)	Windows	.NET Framework 4.6.2 or later	Compatible with SpecSync v2.1 usage
Native binaries for Linux or macOS (Download)	Linux, macOS	-	Larger package (~35MB)
Official SpecSync Docker image (Docker Hub)	Windows, Linux, macOS	Docker (Linux containers)	Ready-to-run images that require no installation

Video tutorial about installing SpecSync as a .NET tool

Once SpecSync has been installed, you need to setup and configure it before the first use. Check the Setup and Configure page for the details.

The Command line reference page contains all available commands and options you can perform with SpecSync and the Configuration page contains the reference documentation for the SpecSync configuration file.

Please also review all synchronization and test result publishing features as well.

Setup and Configure

Command line reference

Configuration reference

Features

For setting up SpecSync for for a working example project, you can also check the Getting started guide.