Install as .NET Console App

This install method is available for Windows machines with .NET Framework v4.6.2 or higher. Other installation options available.

SpecSync can be used as a .NET Framework Windows Console App (SpecSync4Jira.exe). The tool can be downloaded from NuGet.org (for .NET projects) or as a downloadable zip package for other development platforms.

Installing SpecSync .NET Console App from NuGet for .NET projects

The SpecSync .NET Console App is wrapped as a NuGet package, SpecSync.Jira.Console. The Console App is located in the tools folder of the package.

Step 1: Install package

Installing it to a .NET project is similar to other NuGet packages. You can use the NuGet package manager in Visual Studio or the package management console.

Install-Package SpecSync.Jira.Console

Since the NuGet package does not contain any library that would be referenced from the project, the package does not have a dependency on the .NET Framework used by the project.

Depending on your project setup, the package has been downloaded and extracted to

• into the packages folder of your solution: <SOLUTION‑FOLDER>\packages\SpecSync.Jira.Console.<SPECSYNC‑VERSION>

• into the global packages folder: C:\Users\<USER>\.nuget\packages\SpecSync.Jira.Console\<SPECSYNC‑VERSION>

• into an other folder configured in the NuGet.config file

Step 2: Create/review a CMD file in order to execute the console app easily from the installation folder (optional)

As the package installation folder is pretty complicated to type-in frequently, it is recommended to add a simple command line shell script (SpecSync4Jira.cmd) that executes the tool from the right folder.

A SpecSync4Jira.cmd script that executes the SpecSync .NET Console App from the global packages folder might look similar to this (the version number has to be set according to the SpecSync version you use):

@REM Executing SpecSync .NET Console App by forwarding all command line parameters
@REM Note: the version number has to be updated after a SpecSync version upgrade
SET SPECSYNC_VERSION=1.1.1
%HOMEPATH%\.nuget\packages\SpecSync.Jira.Console\%SPECSYNC_VERSION%\tools\SpecSync4Jira.exe %*

In case you use NuGet packages from the packages folder of your solution the path in the script has to be changed accordingly.

Step 3: Verify installation

SpecSync is ready to run using the SpecSync4Jira.cmd script. You can test the installation by checking the installed SpecSync version.

SpecSync4Jira.cmd version

If the correct version number is displayed, you are ready to move on to setup and configure SpecSync for the first synchronization. Check the Setup and Configure page for the details.

Installing SpecSync .NET Console App for other development platforms

The SpecSync .NET Console App can be downloaded directly as a zip file from our website. The download URLs can be found on the Downloads page.

After extracting the package, the SpecSync4Jira.exe executable can be found in the tools folder.

Verify installation

You can test the installation by checking the installed SpecSync version. Open a command prompt from your project folder and invoke the following command.

<EXTRACTED-SPECSYNC-FOLDER>\tools\SpecSync4Jira.exe version

If the correct version number is displayed, you are ready to move on to setup and configure SpecSync for the first synchronization. Check the Setup and Configure page for the details.