@navxio/coin
v0.2.0
Published
An experimental command line application to track/manage your cryptocurrency portfolio across different exchanges
Downloads
10
Readme
coin
An experimental command line application to track/manage your cryptocurrency portfolio across exchanges
Installation
With npm
[sudo] npm i -g @navxio/coin
With yarn
yarn global add @navxio/coin
Configuration
Need to setup the apiKeys and secrets of each enabled exchange in config.json at the following location
Unix: ~/.config/@navxio/coin
Windows: %LOCALAPPDATA%\@navxio\coin
Can be overridden with XDG_CONFIG_HOME
Example Configuration File
{
"binance": {
"apiKey": "binance-api-key",
"secret": "my-binance-secret"
},
"bitfinex": {
"apiKey": "bitfinex-api-key",
"secret": "my-bitfinex-secret"
}
}
Usage
$ npm install -g @navxio/coin
$ coin COMMAND
running command...
$ coin (-v|--version|version)
@navxio/coin/0.2.0 linux-x64 node-v11.9.0
$ coin --help [COMMAND]
USAGE
$ coin COMMAND
...
Commands
coin dash
coin exchange
coin help [COMMAND]
coin setup
coin ticker [EXCHANGE] [SYMBOL]
coin update [CHANNEL]
coin dash
Display user portfolio in tabular form
USAGE
$ coin dash
OPTIONS
-D, --detailed Detailed portfolio with values across exchanges
-e, --exchange=exchange The exchange to fetch the data from
DESCRIPTION
Display user portfolio in tabular form
See code: src/commands/dash.js
coin exchange
Configure exchanges with Coin
USAGE
$ coin exchange
OPTIONS
-a, --available List supported exchanges
-e, --enabled List enabled exchanges
-r, --remove=remove Remove an exchange from coin
-s, --setup=setup Setup a new exchange
See code: src/commands/exchange.js
coin help [COMMAND]
display help for coin
USAGE
$ coin help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
coin setup
Run through the setup wizard
USAGE
$ coin setup
See code: src/commands/setup.js
coin ticker [EXCHANGE] [SYMBOL]
Fetch the 24 hour ticker data
USAGE
$ coin ticker [EXCHANGE] [SYMBOL]
See code: src/commands/ticker.js
coin update [CHANNEL]
update the coin CLI
USAGE
$ coin update [CHANNEL]
See code: @oclif/plugin-update
Supported Exchanges
src/lib/supported-exchanges.js
Planned Features
- [ ] Price Graphs
- [ ] Place Orders
- [ ] Coin Preferences
License
GPL v3.0