Portfolio

Simple command line tool for tracking your assets (metals, fiat and crypto).

Installation

git clone https://github.com/crystal-money/portfolio.git
cd portfolio

shards install
shards build --release

Usage

Example configuration file

[!NOTE] Available rate providers can be found at https://github.com/crystal-money/money/tree/master/src/money/currency/rate_provider.

currency: EUR

exchange:
  rate_store:
    name: File
    options:
      path: ~/.cache/portfolio/currency-rates.json
      ttl: 15 minutes

  rate_provider:
    name: Compound
    options:
      providers:
        - name: FloatRates
        - name: UniRateAPI
          options:
            api_key: your-api-key

# name: Retirement fund
assets:
  - amount: 10_000.11
    currency: USD
    description: Cash under the mattress

  - amount: 13.37
    currency: BTC
    description: Bitcoin in the wallet

  - amount: 4107
    currency: ETH
    description: Ethereum investment

Running

1. Create a portfolio.yml file with your configuration
2. Run ./bin/portfolio --config /path/to/portfolio.yml

Contributing

1. Fork it (https://github.com/crystal-money/portfolio/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• Sijawusz Pur Rahnama - creator and maintainer