HomeSpecSyncInstallation

Installation

Download, install and setup SpecSync

SpecSync can be installed in different ways depending on the project context.

For machines with .NET installed, the easiest way to install SpecSync as a .NET tool, but you can also download native binaries for WindowsmacOS or Linux. SpecSync can also be used as a Docker container.

For all installation options and detailed instructions, please check the Installation & Setup documentation page.

The native binaries can be downloaded from the Downloads page. 

The official SpecSync Docker images are on Docker Hub.

Setup and Configure

Once you have installed SpecSync tool, you need to configure it. This means you have to create a SpecSync configuration file (specsync.json) that contains the remote server connection details and other synchronization settings. The “init” command can be used to configure the connection and the most common settings.

The Setup and Configure guide contains detailed instructions on how to create the initial configuration.

For a detailed reference, please check the Configuration Reference and the Command Line Reference sections of the documentation.