# 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
```


---

# 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://donny-rollproject.gitbook.io/ngi-sync/installation.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.