Skip to content
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
img
src
test
.eslintrc
.gitignore
.snyk
LICENSE
README.md
package.json
yarn.lock

README.md

coin

An experimental command line application to track/manage your cryptocurrency portfolio across exchanges

oclif Version Downloads/week License

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

Display user portfolio in tabular form

Coin Dash screenshot Detailed Portfolio Screenshot

USAGE
  $ coin dash

OPTIONS
  -D, --detailed           Detailed portfolio with values across exchanges
  -e, --exchange=exchange  The exchange to fetch the data from

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 Ticker Screenshot

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

Supported Exchanges

Planned Features

  • Price Graphs
  • Place Orders
  • Coin Preferences

License

GPL v3.0

You can’t perform that action at this time.