Hledger setup with multi-year files, multi-source imports and a range of auto-generated reports
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
LICENSE
README.md

README.md

Full-fledged Hledger

Full-Fledged Hledger setup with multiple yearly files, multi-source CSV imports and a range of auto-generated reports.

All new users please READ THE WIKI -- at the very least read the 'Getting started' page to get going.

What is included?

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 named branches in the repo, which you can mix and match.

CLICK HERE FOR THE WIKI

Installation

Scripts and files here assume Linux-like environment with Haskell (in particular, you will need runhaskell and stack) and textutils/shellutils available. I have not tested them on Mac OS or Windows.

You will need to have shake build system installed (which you can get via stack install shake). Scripts used to convert CSV files assume that you will end up having many files, so scripts use GNU parallel to run as many conversion jobs as you have CPU cores. If parallel is not available, scripts will process files sequentially.

Usage

TL;DR: Pick one of the numbered branches of this project:

  • 01-getting-started
  • 02-getting-data-in
  • ... and so on Each numbered branch includes all the code from preceeding branches as well. 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.

Read the wiki

Did I mention that you should go and read the wiki?