Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 2.13 KB

README.md

File metadata and controls

42 lines (27 loc) · 2.13 KB

"Full-fledged Hledger" Tutorial

Full-Fledged Hledger is a tutorial on how to setup up hledger to get:

  • data split into files by year
  • multi-source CSV imports
  • range of auto-generated reports
  • single script to update all reports when any source file change
  • 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.

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.

CLICK HERE FOR THE WIKI

Usage

TL;DR: Pick one of the numbered directories:

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.

Read the wiki

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