A command line cryptocurrency portfolio manager and price tracker

Go to file

Michael Clemens dd93c0ef3e Update README.md		2018-01-28 19:26:45 +01:00
.shellfolio	new config file format for "gain" feature	2018-01-28 19:22:17 +01:00
LICENSE	Initial commit	2018-01-23 14:20:22 +01:00
README.md	Update README.md	2018-01-28 19:26:45 +01:00
screenshot_cli.png	Add files via upload	2018-01-23 17:22:07 +01:00
shellfolio.sh	added column "gain"	2018-01-28 19:21:20 +01:00

README.md

shellfolio

shellfolio is a cryptocurrency portfolio manager and price tracker for the CLI. It gathers it's information from coinmarketcap.com, calculates what your coins are worth, what your gains and losses are and presents the results on the shell:

Installation

Copy the file .shellfolio into your home directory
Copy the file shellfolio.sh into a directory that is in you PATH variable
Set the correct file permissions: chmod u+x shellfolio.sh

Configuration

Edit the file ~/.shellfolio like this:

COINS="ethereum ripple stellar iota cardano digibyte neo nem dogecoin bitcoin-cash"
ETH=4.3:0
XRP=234:0
XLM=3984:0
MIOTA=389:0
ADA=821:0
DGB=9821:0
NEO=10.3:0
XEM=821:0
DOGE=987324:0
BCH=20:0

The variable $COINS defines all coins you want to be listed, must be referenced by their name. All other variables are coins you own (must be the ticker name), their value represents the amount you have. Insert how much you invested (in USD) after ":" in order to see your gains and losses.

In summary the variable definiton for each coin is:

$SYMBOL=amount:investment