cdash

cdash

A minimalist cryptocurrency portfolio dashboard for the command-line that draws market data from the CoinMarketCap API.

Installing

1. Visit the Releases page
2. Download the appropriate executable
3. Optionally rename the downloaded executable
4. Optionally place the executable on your system PATH

Configuring

Specify your holdings via a yml file structured as follows:

---
- symbol   : BTC
  holdings : 100

- symbol   : LTC
  holdings : 100

- symbol   : ETH
  holdings : 100

By default, cdash will attempt to open this file at ~/.config/cdash.yml. If you choose to store it elsewhere, provide cdash the approriate path using the --config option:

cdash --config=/path/to/cdash.yml

Ambiguous currency symbols

Some cryptocurrency symbols are not unique, which can cause problems due to ambiguity. To resolve this, cdash also allows currencies to be specified by CoinMarketCap id:

---
- symbol   : BTC
  holdings : 100

- symbol   : LTC
  holdings : 100

- symbol   : ETH
  holdings : 100

- id       : bitcoin-gold # symbol "BTG"
  holdings : 100

- id       : bitgem       # also symbol "BTG"
  holdings : 100

cdash will fail with an error if your config file contains references to ambiguous symbols.

Specifying the base currency

The base currency may be specified using the --base flag. The following currency codes are supported:

The --base option is case-insensitive, and defaults to USD.

Windows Usage

cdash uses ANSI escape sequences for colorization. Windows users must take note to use a compatible shell.