https://github.com/kantord/ledger-cli-dashboard
:moneybag: :bank: :chart_with_upwards_trend: Customizable graphical reporting for ledger
https://github.com/kantord/ledger-cli-dashboard
accounting business-intelligence dashboard finance jq just-dashboard ledger ledger-cli makefile personal-finance plaintext-accounting
Last synced: 25 days ago
JSON representation
:moneybag: :bank: :chart_with_upwards_trend: Customizable graphical reporting for ledger
- Host: GitHub
- URL: https://github.com/kantord/ledger-cli-dashboard
- Owner: kantord
- License: gpl-3.0
- Created: 2018-03-25T14:41:33.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T14:37:09.000Z (over 1 year ago)
- Last Synced: 2025-02-02T19:45:20.411Z (3 months ago)
- Topics: accounting, business-intelligence, dashboard, finance, jq, just-dashboard, ledger, ledger-cli, makefile, personal-finance, plaintext-accounting
- Language: Makefile
- Homepage:
- Size: 562 KB
- Stars: 53
- Watchers: 6
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ledger-cli-dashboard
This is a graphical reporting tool for [ledger](https://www.ledger-cli.org/), created using the desktop version of [just-dashboard](https://kantord.github.io/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.