Skip to content

Latest commit

 

History

History
97 lines (57 loc) · 2.83 KB

README.md

File metadata and controls

97 lines (57 loc) · 2.83 KB
Raw

hodlings

⚠️ You need node.js v13.8.0 or higher.

Display value of crypto-currency hodlings.

Sample output:

Sample Output

Prerequisites

Summary: node.js and git. You can skip to the next section if you already have these.

  • node.js platform v13.8.0+. Recent version is needed because of ES6 modules.

  • git incredible version control (needed in the background to install some dependencies on first install).

Optional: if you want easy switching between different node.js versions in the future and you are using unix based systems (macOS, Linux), you can install node.js via fantastic n (don't download it from nodejs.org in this case).

You can also install both node.js and git via Homebrew friendly package manager for macOS. n is still recommended for node.js though.

npm (Node Package Manager) is installed automatically with node.js install (just FYI).

Install hodlings project

In Terminal (Linux, macOS) or Command Prompt (Windows) type:

npm install -g hodlings

Run

hodl

Options

Try hodl -h for complete list and here are a few examples:

hodl -x eur

hodl -x cny

Add --eth to focus on Ethereum or --btc to focus on Bitcoin and save space for two unneeded columns.

Converter

hodl --convert 2 eth usd

hodl --convert 20 deus dei

hodl --convert 20 dei usdc

etc.

Configure

Create or edit the file ~/.hodlings (Linux/MacOS: /home/[user], Windows: c:\Users\[user]) containing your portfolio. Use # to put in comments.

Example

Specifying the entire portfolio is simple:

# Hodlings
BTC: 0.3123
ETH: 14.99858897
DAI: 148
DEUS: 623
SOL: 500
LUNA: 1000
...

Project is currently using CoinGecko API.

Notes

If you run hodl without this file present, it will create an example file for your convenience.

Complete options

  Usage: hodl [options]

  Options:

    -x, --currency <currency>                 currency to display (usd, eur, cny, jpy...)
    -c, --convert <amount> <token1> <token2>  convert between tokens (and/or fiat)
    --eth                                     focus on eth, hide the bitcoin-specific columns (value-btc, 7-day-change-vs-btc)
    --btc                                     focus on btc, hide the ethereum-specific columns (value-eth, 7-day-change-vs-eth)
    -h, --help                                output usage information

Updates and attribution

hodlings is thanking crytrac project for initial idea.

Thanx again to Joe Wasson for a great project which persuaded with simplicity and nice look.