# Configuration wizards

SpecSync provides configuration wizard commands that can help creating or modifying the [SpecSync configuration files](/specsync/jira/features/general-features/configuration-file.md).

The wizards can be invoked from and interactive console like the other command line tool and they go through several steps to prepare the configuration change. The prepared configuration changes are summarized as the last wizard step and the user can confirm or reject the changes.

You can cancel the configuration wizards at any step by pressing *Ctrl+C*.

During the wizard execution, you might be prompted for specifying different configuration values or choices. For those prompts where there is a meaningful default answer, the default is displayed in parenthesis (e.g. `Do you want to check connection? (yes)`). When pressing the *Enter* key without specifying any value, the default value will be used.

The sections below describe the available wizards.

## Init wizard

The `init` command initializes SpecSync configuration by creating a `specsync.json` configuration file based on the settings provided for the interactive questions asked by the command.

```
dotnet specsync init
```

Please find the available command line options at the [`init` command](/specsync/jira/reference/command-line-reference/init-command.md) reference page.

It is recommended to invoke the `init` command from the common root folder of the local test cases (feature files) to be synchronized.

During the execution of the command, the basic configuration settings (project URL and authorization settings) can be specified. The init command verifies the connection to the Jira project specified to avoid common authentication issues.

In case of [Personal Access Token (PAT) authentication](/specsync/jira/features/general-features/server-authentication-options.md), the command also offers you to save the authentication details to the user-specific configuration file, so that the credentials are not included in the project configuration.

The `init` command also offers configuring some useful optional features, like [remote scope](/specsync/jira/features/common-synchronization-features/remote-scope.md) or [hierarchy synchronization](/specsync/jira/features/common-synchronization-features/synchronizing-test-case-hierarchies.md).

## Upgrade wizard

{% hint style="warning" %}
This feature is available with SpecSync v5 or above.
{% endhint %}

The `upgrade` command upgrades the SpecSync configuration file after a SpecSync version upgrade.

```
dotnet specsync upgrade
```

Please find the available command line options at the [`upgrade` command](/specsync/jira/reference/command-line-reference/upgrade-command.md) reference page.

The command performs upgrades the configuration simple changes (e.g. renamed settings) automatically and provides options to configure optional features as well that have been introduced with the new version.

The `upgrade` command only modifies the configuration file but it does not change anything in the Jira. So you can perform the `upgrade` command safely and review the changes in the configuration file manually before performing a synchronization.

{% hint style="info" %}
You do not have to configure all optional feature with the `upgrade` command in one step. You can of course configure these features also manually by modifying the configuration file, but you can also re-run the `upgrade` command later to configure these.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.specsolutions.eu/specsync/jira/features/general-features/configuration-wizards.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
