https://github.com/bitfinexcom/svc-js-cli
https://github.com/bitfinexcom/svc-js-cli
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/bitfinexcom/svc-js-cli
- Owner: bitfinexcom
- License: apache-2.0
- Created: 2017-10-23T11:32:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-27T21:17:44.000Z (over 2 years ago)
- Last Synced: 2025-04-11T06:18:27.614Z (about 1 year ago)
- Language: JavaScript
- Size: 24.4 KB
- Stars: 9
- Watchers: 8
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# svc-js-cli
Bootstraps Grenache Services.
## Installation
```
npm i -g https://github.com/bitfinexcom/svc-js-cli.git
# or link it (good for development):
git clone https://github.com/bitfinexcom/svc-js-cli
cd svc-js-cli
npm link
```
You'll also need an up-to-date fork of the base repo you want to use as service base, e.g.
- https://github.com/bitfinexcom/bfx-svc-js
- https://github.com/bitfinexcom/bfx-util-js
- https://github.com/bitfinexcom/bfx-ext-js
## Usage
Internally the CLI copies a base service, e.g. bfx-util-js over to the new target directory and creates required files and configurations to run a basic service. The first two arguments are the service-name and the port for the new service. After that you have to provide the service source, e.g. `bfx-util-js`.
*Note:* the upstream path is derived from the directory name of the service source, but can be overriden with the `--upstream` argument.
To setup a util-js based Grenache API service, run:
```
svc-js-cli init grenache-api-base
Example:
svc-js-cli init grenache-api-base bfx-util-net-js 1337 ~/bitfinex/bfx-util-js
```
The CLI sets this repo as an origin called upstream. If you need to merge upstream run:
```
bash upstream_merge.sh
```