search

interledger-deprecated / ilp-kit-cli

Tools for connector configuration management
Other
5 stars 2 forks source link

readme

ilp-kit-cli npm

Utility scripts to configure and start ILP Kit

Installation

npm install -g ilp-kit-cli

Usage

Configuring

In order to configure ILP Kit, all you have to do is run ilp-kit-config my-env.list. This will create a script full of environment variables called my-env.list, which can be used by ILP Kit (see 'Running'). A command-line interface will walk you through the required steps.

If you want to configure a connector as part of your ILP Kit, the CLI will prompt you for the number of plugins your connector will use. Plugin-specific questions will be asked in order to create appropriate configurations for each plugin. Note that if your ids are not unique, then you may overwrite other plugins. You can edit the final output in the CONNECTOR_LEDGERS field of my-env.list. It is output in the form of a stringified JSON object.

Running

The environment file output by ilp-kit-config can be used to start a ledger, UI, and connector. In the directory of ILP Kit, run:

$ cp my-env.list ./env.list ; npm start

The configuration is evaluated, setting each of the required environment variables. Then the ILP Kit is launched with npm start, which reads from the environment for configuration.