shellfolio/README.md

38 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2018-01-23 13:20:22 +00:00
# shellfolio
2018-01-23 13:35:30 +00:00
2018-01-28 18:24:53 +00:00
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:
2018-01-23 13:35:30 +00:00
2018-01-29 12:36:45 +00:00
![screenshot](/screenshot2.png?raw=true "screenshot")
2018-01-23 15:13:30 +00:00
2018-01-23 13:35:30 +00:00
# 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
2018-01-23 13:35:53 +00:00
Edit the file _~/.shellfolio_ like this:
2018-01-23 13:35:30 +00:00
```
2018-01-28 18:25:47 +00:00
COINS="ethereum ripple stellar iota cardano digibyte neo nem dogecoin bitcoin-cash"
2018-01-29 12:43:17 +00:00
ETH=4.3:233
XRP=23234:342
XLM=3984:533
MIOTA=3829.2:24333
ADA=821:324
DGB=9821:3454
NEO=10.3:99
XEM=821:123
DOGE=987324:435
BCH=20:2
2018-01-23 13:35:30 +00:00
```
2018-01-28 18:24:53 +00:00
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.
2018-01-28 18:26:45 +00:00
In summary the variable definiton for each coin is:
$SYMBOL=amount:investment