> For the complete documentation index, see [llms.txt](https://donny-rollproject.gitbook.io/ngi-sync/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://donny-rollproject.gitbook.io/ngi-sync/installation.md).

# Getting Started

## Requirements

### Windows

* Nodejs 12+
* Install [CMake](https://cmake.org/download)
* Git bash includes Rsync, OpenSSH
* `npm install` requires some tools to be present in the system like Python and C++ compiler. Windows users can easily install them by running the following command in PowerShell as administrator. For more information see <https://github.com/felixrieseberg/windows-build-tools>

```bash
npm install --global --production windows-build-tools
```

* `yarn install` : <https://classic.yarnpkg.com/en/docs/install/#windows-stable>

### Linux (apt)

* Nodejs 12+
* Install [CMake](https://cmake.org/download)
* Rsync, OpenSSH
* `yarn install` : [https://classic.yarnpkg.com/en/docs/install](https://classic.yarnpkg.com/en/docs/install/#windows-stable)
* Python and build-essential :

```
sudo apt install -y make python build-essential
```

### macOS

* Nodejs 12+
* Install [CMake ](https://cmake.org/download)
* Rsync, OpenSSH
* `yarn install` : [https://classic.yarnpkg.com/en/docs/install](https://classic.yarnpkg.com/en/docs/install/#windows-stable)
* Xcode is needed to compile the sources, this can be installed from the App Store.

## Installing ngi-sync

Clone from github

```bash
git clone git@github.com:rolldone/ngi-sync.git ngi-sync
```

then :

```bash
npm install copyfiles -g
```

```bash
cd ngi-sync && yarn install
```

```bash
npm run build && yarn link -f
```