cryptofolio

README

Cryptofolio

A program to display your cryptocurrency balances in fiat currency - best for HODLers

Requirements

If building from source, ensure Golang is installed on your system

Caveats

Currently...

This program leverages the Coincap API for markets data reference.

Only USD fiat currency is supported.

All input data is sourced from a user supplied manifest file in JSON format (e.g. YOURFILENAME.json) via the -manifest argument.

Configuration

Edit your JSON manifest file with your asset data. The manifest must include an array of objects. Object properties include:

• id (string, required): Coincap API asset identifier
• quantity (float, required): quantity of the asset you currently hold

Example: manifest.json

[
  {
    "id": "bitcoin",
    "quantity": 10.0
  },
  {
    "id": "bitcoin-cash",
    "quantity": 10.0
  },  
  {
    "id": "ethereum",
    "quantity": 10.0
  },
  {
    "id": "cardano",
    "quantity": 10.0
  },  
  {
    "id": "xrp",
    "quantity": 10.0
  }
]

Usage

You can either compile the program from source, or download a pre-compiled binary specific to your operating system

Build

From the repository root directory, run the following shell command:

go build

Execute

Invoke the binary relative to your operating system via shell:

Linux/MacOS

./cryptofolio -manifest=/path/to/your/manifest.json

Windows

.\cryptofolio.exe -manifest=C:\path\to\your\manifest.json