"Full-fledged Hledger" Tutorial
Full-Fledged Hledger is a tutorial on how to setup up hledger to get:
- ledger files split by year
- multi-source CSV imports
- range of auto-generated reports
- single script to update all reports when any source file changes
- full freedom to evolve and refactor your journals as you see fit
All new users please READ THE WIKI -- at the very least read the 'Getting started' page to get going.
Usage
TL;DR: Pick one of the numbered directories:
- 01-getting-started
- 02-getting-data-in
- ... and so on
Each numbered directory is self-contained and includes all the code and source files from preceeding directory. Choose a starting point that suits you, clone it to the place of your choosing, run export.sh, and start populating your journals.
Head on to the Wiki to read the full story of how to grow your setup step by step and decide which bits and pieces you want to adopt.
Feel free to ignore all the scripts at the top level of the repo - they are there to help maintain the project and are not part of the hledger setup.
Wiki Table of Contents for the impatient
- Key principles and practices
- Getting started
- Getting data in
- Getting full history of the account
- Adding more accounts
- Creating CSV import rules
- Maintaining CSV rules
- Investments - easy approach
- Mortgages
- Remortgage
- Foreign currency
- Sorting
expenses:unknown - File-specific rules
- Tax returns
- ChangeLog
What would you find here?
A set of sample journals and helper scripts that I use together with hledger for tracking personal finances and budgeting. It should be easily adaptable to other command-line accounting tools (ledger, beancount, ...).
I went through several different approaches over the course of 10 years, and this is the end result of that journey, complete with "how", "why" and lessons learned.
My story is explained on the Wiki and illustrated by the directories in the repo. You can choose the one that best suits you as a starting point or look at the diffs between different directories to mix and match features as you see fit.
How large is my setup?
According to hledger stats, as of 2022 it contains:
- 335 journal files (294 of them autogenerated)
- 6800 days of data
- 28500 transactions
- 9700 payees/descriptions
- 320 accounts (with max depth of 5)
- 20 commodities
So, decently large. It takes about a minute to regerenate all journal files and reports from scratch.
Read the wiki
Did I mention that you should go and read the wiki?
Awk, and Shake, and csvtools, and shell scripts, ...?!
There is docker image that includes all the dependencies and tools. Just clone this repo, run ./docker.sh and you should be all set.
Also, check out hledger-flow - it might suit you better, as all the automation code is contained in a single binary.