SpecSync Documentation
Jira
Azure DevOpsJira
Jira
Azure DevOpsJira
  • Introduction to SpecSync for Jira
  • Getting started
    • Getting started using SpecFlow
    • Getting started using Cucumber or other Gherkin-based BDD tool
  • Installation & Setup
    • Install as .NET tool
    • Install as .NET Console App
    • Install as native binaries for Linux or macOS
    • Install as Docker image
    • Setup and Configure
  • Features
    • Push features
      • Pushing scenario changes to Test Cases
      • Configuring the format of the synchronized test cases
      • Synchronizing Scenario Outlines
      • Update Test Case fields
      • Attach files to Test Cases using tags
      • Customization: Setting Test Case fields with default values
      • Customization: Update custom Test Case fields on push
      • Customization: Ignoring marked Test Case steps
      • Customization: Ignoring Test Case Tags
      • Customization: Ignore non-supported local tags
      • Customization: Mapping tags
      • Customization: Synchronizing scenarios from feature branches
      • Customization: Automatically link changed Test Cases
      • Customization: Synchronize linked artifact titles
      • Customization: Do not synchronize title
    • Pull features
      • Pulling Test Case changes to local scenarios
    • Common synchronization features
      • Configuration key
      • Remote scope
      • Linking Work Items using tags
      • Synchronizing Test Case hierarchies
      • Excluding scenarios from synchronization
      • Synchronization conflict resolution
    • Test result publishing features
      • Publishing test result files
    • General features
      • Jira authentication options
      • Configuration file
      • Hierarchical configuration files
      • Local test case conditions
      • Configuration wizards
      • SpecSync plugins
    • Customizations
    • Plugin list
  • Licensing
  • Guides
    • What is my Jira server URL?
    • Jira Test Case Management (TCM) solution
    • How to define the local feature-set to be synchronized
    • Filters and scopes
    • How to use SpecSync from build or release pipeline
    • How to upgrade to a newer version of SpecSync
    • How to attach files to test results
    • Using SpecSync with Cucumber
    • Using SpecSync with Cypress
    • Using SpecSync with Postman
    • Using SpecSync with TestNG
    • Using SpecSync on macOS or Linux
    • Using SpecSync inside a Docker container
    • Migrating from SpecSync v1 to v5
  • Changelog
  • Release Model and Roadmap
  • Downloads
  • Reference
    • Command line reference
      • init
      • upgrade
      • push
      • pull
      • publish-test-results
      • version
    • Configuration reference
      • toolSettings
      • local
      • remote
      • jira
      • knownRemotes
      • synchronization
        • push
        • pull
        • links
        • attachments
        • format
        • fieldUpdates
      • hierarchies
      • publishTestResults
      • specFlow
      • customizations
    • Compatibility
    • Older versions
  • Contact
    • SpecSync Support
    • Troubleshooting
    • FAQ
  • Project Website
Powered by GitBook
On this page

Was this helpful?

Installation & Setup

PreviousGetting started using Cucumber or other Gherkin-based BDD toolNextInstall as .NET tool

Last updated 1 month ago

Was this helpful?

SpecSync for Jira 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

Windows, Linux, macOS, Docker

.NET 6 SDK or later (including .NET 7, 8, 9)

Recommended

Windows

.NET Framework 4.6.2 or later

Linux, macOS

-

Larger package (~35MB)

Windows, Linux, macOS

Docker (Linux containers)

Ready-to-run images that require no installation

(NuGet, Download)

(NuGet, Download)

(Download)

(Docker Hub)

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

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

Please also review all as well.

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

Setup and Configure
Command line reference
Configuration
synchronization and test result publishing features
Setup and Configure
Command line reference
Configuration reference
Features
Getting started
.NET tool
.NET Console App
Native binaries for Linux or macOS
Official SpecSync Docker image
Video tutorial about installing SpecSync as a .NET tool