open-index/open-npm huggingface dataset:
npm package: @simtech/vrp-tools
Description: Utilities to support VRP
Author: SIMTech VRP Team
Latest version: 2.4.0

- [Installation](#installation)
    - [Step 1-2: Programs Required](#step-1-2-programs-required)
- [Running](#running)
- [Features](#features)
    - [genOrder](#genorder)
    - [syncCollection](#synccollection)

# Installation

## Step 1-2: Programs Required

Step 1: **Install Nodejs** - Install the latest stable version (at least 8.10.0) of Nodejs via [nodejs.org](https://nodejs.org/en/)

Step 2: **Install vrp-tools** - `npm install vrp-tools -g`

# Running

For example, create `50` orders in `Logistics_Test` table in `127.0.0.1` SQL server

If running via source code,

`node ./bin/vrpTools.js genOrder -n 50 -d Logistics_Test -S 127.0.0.1 -U sa -P mypassword`

If running directly using published `vrp-tools`,

`vrp-tools genOrder -n 50 -d Logistics_Test -S 127.0.0.1 -U sa -P mypassword`

# Features

 | ACTION         | DESCRIPTION                                                      |
 | -------------- | ---------------------------------------------------------------- |
 | genOrder       | generates n number of delivery orders and inserts into SQL DB    |
 | syncCollection | syncs mongoDB collections of given server and azure cloud server |

## genOrder

 `vrp-tools genOrder -n <n> -U [username] -P [password] -S [server] -d [database]`

| Option            | Description                        |
| ----------------- | ---------------------------------- |
| -U, --user        | username of sql db to be connected |
| -n, --numOfOrders | number of orders to be generated   |
| -P, --pass        | password of sql db to be connected |
| -S, --server      | server ip of db to be connected    |
| -d, --database    | name of sql db to be connected     |

## syncCollection

 `vrp-tools syncCollection -U [username] -c[collection] -P [password] -S[serverport] -d [databasename] -t [clouddbname] -r [cloudservername]`

| Option            | Description                                                    |
| ----------------- | -------------------------------------------------------------- |
| -U, --user        | username of mongodb to be connected                            |
| -c, --collection  | name of collection to be synced                                |
| -P, --pass        | password of mongodb to be connected                            |
| -S, --serverPort  | ip and port of server to which mongo collection to be imported |
| -d, --database    | name of mongodb to be connected                                |
| -t, --cloudDbName | name of the DB to which mongo collection to be imported        |
| -r, --cloudServer | name of the cloud server                                       |