# Getting Started

The following steps cover manual installation of JadeGit, useful for getting started in a local development environment.  Developers of existing systems may want to skip ahead to look at [migration strategies](/jadegit/migration/overview.md) for adopting JadeGit.

## Installation

Download the [latest release](https://gitlab.com/jadelab/jadegit/-/releases) for the Jade platform version you're using, and copy the binaries into the bin folder of the database being setup.

Configure the database to use JadeGit for development by adding the following settings to the [Jade initialization file](https://secure.jadeworld.com/developer-centre/Jade2025/OnlineDocumentation/?#resources/jadeini/ch1jadeinifile/ch1jadeinifile.htm).

```ini
[JadeSecurity]
JadePatchControlSecurity=true
DevelopmentSecurityLibrary=jadegitdev
```

{% hint style="success" icon="lightbulb" %}
JadeGit can also be enabled or disabled by [specifying the INI settings as part of the command line parameters](https://secure.jadeworld.com/developer-centre/Jade2022/OnlineDocumentation/#resources/installconfig/ch2configuringjade/placing_initialization_file_parameters_on_the_command_line.htm) for a Jade shortcut (running in single-user mode).
{% endhint %}

## Sign On

On start up of the Jade IDE, the JadeGitSchema will be installed automatically during logon.

{% hint style="warning" %}
You may be shown an error about a missing MSVC library.  To fix this, you'll need to install the latest [Microsoft Visual C++ Redistributable for Visual Studio 2022](https://aka.ms/vs/17/release/vc_redist.x64.exe).
{% endhint %}

Following logon, the JadeGit Changes explorer appears to the right of the screen.  It cannot be closed directly and will be restarted if terminated, but may be minimized if preferred during development.

<figure><img src="/files/GJOmQD1H3YqEuiz91co4" alt=""><figcaption></figcaption></figure>

{% hint style="info" icon="screwdriver-wrench" %}
To keep both visible at the same time, the Jade IDE needs to be resized/positioned to the left of the JadeGit Changes explorer.  In future, this may be streamlined with JadeGit being integrated within the IDE, if [JEDI #383](https://jedi.ideas.jadeworld.com/ideas/JAD-I-383) is progressed.
{% endhint %}

## Multi-User Support

Jade developers are typically accustomed to working in a multi-user environment, however JadeGit is currently limited to running in single-user mode only, which is a notable paradigm shift.

This is a technical limitation rather than a design choice. Extending access beyond a single user depends on the following:

* Changes needed to retrieve the [global git configuration for thin-clients](https://gitlab.com/jadelab/jadegit/-/issues/116).
* [JEDI #402](https://jedi.ideas.jadeworld.com/ideas/JAD-I-402) to support development via a standard client node, either an application server or an IDE running as a standard client directly.

However, even with those resolved, further work will be needed to support developers working on independent changes simultaneously within the same environment.

{% hint style="info" icon="shuffle" %}
To test changes during local development, this limitation can be worked around by complementing a single-user IDE shortcut for development with those needed to start the database server and client nodes in multi-user mode for testing (while the IDE isn't open).
{% 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://jadelab.gitbook.io/jadegit/developers/getting-started.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.
