# Configuration file

This page contains general information about the SpecSync configuration files. For a list of all configuration options, please check the [Configuration](/specsync/jira/reference/configuration.md) reference.

## The `specsync.json` configuration file.

SpecSync can be configured using a json configuration file, by default called `specsync.json`. This file contains all information required to perform the different synchronization tasks. Some settings of the configuration file can be also overridden from the command line options of the synchronization tool, these are listed in the [Command line reference](/specsync/jira/reference/command-line-reference.md) guide.

An initial configuration file can be generated using the SpecSync [init command](/specsync/jira/reference/command-line-reference/init-command.md).

The `specsync.json` configuration file is a standard JSON file, but it also allows `//` style comments. There is a JSON schema available for the configuration file that contains the available configuration options and a short description.

**It is recommended to edit the SpecSync configuration files in Visual Studio (or other editor that supports JSON schema, like Visual Studio Code) to get auto-completion for editing and documentation hints if you hover your mouse over a setting.**

![Code completion of the configuration file in Visual Studio](/files/3S1D3Ylmyc5Nug5Xd7SG)

## Example

The following example shows a minimal configuration file.

```javascript
{
  "$schema": "https://schemas.specsolutions.eu/specsync4jira-config-v5-latest.json",

  "remote": {
    "serverUrl": "https://specsyncdemo.atlassian.net/",
    "project": "MyCalculator",
  }
}
```


---

# 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-file.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.