@reactivemarkets/switchboard-terminal
v1.7.5
Published
An interactive terminal for the Reactive Markets Switchboard
Downloads
14
Readme
Reactive Switchboard Terminal
An example terminal application connecting to the Reactive Switchboard. It displays the order book, public trades and the bid/offer spread.
Quick Start
npm i -g @reactivemarkets/switchboard-terminal
You need to give the terminal an api key to connect. You can either set an environment variable SWITCHBOARD_API_KEY
or pass in via the command line arg api-key
.
To run with an environment variable:
switchboard-terminal
or with an api key:
switchboard-terminal --api-key MY_API_KEY
Command Line Usage
For a full list of commands see the built in help:
switchboard-terminal --help
Building
To install all dependencies and build run:
git clone https://github.com/reactivemarkets/switchboard-js.git
cd switchboard-js
npm ci
npm run build
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
License
This project is licensed under the Apache 2.0 License - see the LICENSE file for details.