open-index/open-npm huggingface dataset:
npm package: @proppos/fastpay-cli
Description: Fastpay cli to interact with the fastpay service
Author: oscmedgon
Latest version: 3.6.4

# FASTPAY CLI DOCUMENTATION

## TABLE OF CONTENT
1. [Pre-requisites](#PRE-REQUISITES)
1. [Contributing](#CONTRIBUTING)

---

## PRE REQUISITES

There are some requisites that need to be fulfilled before being able to use the CLI.
* The supported CPU architectures supported are `arm64v8` and `amd62`, the CLI doesn't allow using other architectures like for example `arm32v7`.
* The CLI is a node package, and it requires nodejs 12 or higher, an older version may work, but it's not officially supported.
* The CLI uses `docker` and `docker-compose`, so, for being able to interact with the services `docker` and `docker-compose` must be installed manually.
* The `docker` registry authorization need to be granted manually, otherwise, any image that belongs to the proppos `docker` registry will fail to download.

## CONTRIBUTING
Before running CLI in development it's required to have the daemon service running in the machine
, go to the daemon development note in order to launch the daemon.


### EXECUTE CLI IN LOCAL (using the daemon)
In case of doubt, there is an entry in confluence with all the steps to turn on the Daemon and to be able to use the Daemon and the CLI locally.
https://boiradigital.atlassian.net/wiki/spaces/PROPPOS/pages/1172832257/Execute+daemon+in+local

### DEVELOPMENT BUILD
You need to install the project dependencies in first place:
```shell
npm install
```
In order to run the development builder you need to run the following command:
```shell
npm run dev
```

Once the build is done you'll see a new script named fastpay.js, once this is done
the first time, you need to add this build to the npm binaries by executing:
```shell
sudo npm link
```

From now on, fou can run the CLI try it with the following command:
```shell
sudo fastpay help
```

----

### DEPLOYING NEW VERSION

To deploy a new package version of the package you need to follow the standard
procedures.

---

The first time you'll need to set up your npm credentials
follow the [official documentation](https://docs.npmjs.com/cli/v8/configuring-npm/npmrc).

First of all you need to create a new version of the package:
```shell
npm version minor ## Stable version following the standard syntax
## OR
npm version prerelease --preid=rc ## to create a ne pre release version
```

Once the version it's done and pushed to the repository (including the tag)
you have to publish the package version to NPM:
```shell
npm publish
```