ledger-cli-dashboard

This is a graphical reporting tool for ledger, created using the desktop version of just-dashboard. It is more intended as a starting point that you can extend and customize to match your own needs.

Built-in features

Observe long-term tendencies
Chart expenses within a specific month
Automatic currency exchange

Dependencies

yarn
npm
jq
git
ledger

Setup

./setup.sh

Usage

Customize account names

Edit accounts.conf to match your account names:

expenses_account=Expenses
income_account=Income
assets_account=Assets
savings_account=Assets/Savings

Edit expense_categories.conf to match your account names:

Food
Drinks
Rent
Services
Books

Note: Instead of ':' characters, you have to use '/' characters to access sub-accounts.

Display dashboard

./dashboard.sh book.txt USD

Replaced USD with your preferred output currency and book.txt with the path to your ledger file.

Fake data

This repo includes a fake ledger file called 'fake_book.txt' and a Python script which you can use to generate your own fake data.

setup.sh fails with "fatal: reference is not a tree" or c++ compilation errors

I tried to install this awesome-looking program in a docker container, but it fails trying to check out some git SHA. :-(

I admit having zero knowledge of the node.js ecosystem, so this might be something trivial, but is a show-stopper for me. Please help!

Sending build context to Docker daemon  927.2kB
Step 1/6 : FROM debian:stable
 ---> a06aa514c943
Step 2/6 : RUN apt-get update
 ---> Using cache
 ---> 7b34fe6a20f3
Step 3/6 : RUN apt-get install -y yarn npm jq ledger
 ---> Using cache
 ---> 2f772658344a
Step 4/6 : RUN apt-get install -y git
 ---> Using cache
 ---> 3c55d6b06f20
Step 5/6 : ADD . .
 ---> Using cache
 ---> 9ed47f9abe83
Step 6/6 : RUN ./setup.sh
 ---> Running in 28e3928ebe20
npm WARN npm npm does not support Node.js v10.23.1
npm WARN npm You should probably upgrade to a newer version of node as we
npm WARN npm can't make any promises that npm will work with this version.
npm WARN npm Supported releases of Node.js are the latest release of 4, 6, 7, 8, 9.
npm WARN npm You can find the latest version at https://nodejs.org/
npm ERR! code 128
npm ERR! Command failed: /usr/bin/git checkout 7e8f907ed1d6738914def21bbd3ad724017bbb4f
npm ERR! fatal: reference is not a tree: 7e8f907ed1d6738914def21bbd3ad724017bbb4f
npm ERR! 

npm ERR! A complete log of this run can be found in:
npm ERR!     /root/.npm/_logs/2021-01-20T21_11_15_933Z-debug.log
./setup.sh: line 4: cd: ./node_modules/just-dashboard-desktop/: No such file or directory
npm WARN npm npm does not support Node.js v10.23.1
npm WARN npm You should probably upgrade to a newer version of node as we
npm WARN npm can't make any promises that npm will work with this version.
npm WARN npm Supported releases of Node.js are the latest release of 4, 6, 7, 8, 9.
npm WARN npm You can find the latest version at https://nodejs.org/
npm ERR! code 128
npm ERR! Command failed: /usr/bin/git checkout 7e8f907ed1d6738914def21bbd3ad724017bbb4f
npm ERR! fatal: reference is not a tree: 7e8f907ed1d6738914def21bbd3ad724017bbb4f
npm ERR! 

npm ERR! A complete log of this run can be found in:
npm ERR!     /root/.npm/_logs/2021-01-20T21_11_25_607Z-debug.log
npm WARN npm npm does not support Node.js v10.23.1
npm WARN npm You should probably upgrade to a newer version of node as we
npm WARN npm can't make any promises that npm will work with this version.
npm WARN npm Supported releases of Node.js are the latest release of 4, 6, 7, 8, 9.
npm WARN npm You can find the latest version at https://nodejs.org/
npm ERR! missing script: dist:dir

npm ERR! A complete log of this run can be found in:
npm ERR!     /root/.npm/_logs/2021-01-20T21_11_26_315Z-debug.log

kantord / ledger-cli-dashboard Goto Github PK