d3ef6df75a
Updates inspired by some feedback from README reviewer Lars Wirzenius.
("I like that the README starts with an explanation of what the project
is all about. I like that the README is short and to the point. I like
that the license is stated explicitly.
I feel that the README doesn't really present the whole plain text
accounting concept very well, though. I realize that linked home page
goes into that much more, but it might be worth add a short example of
a ledger input file, and a sample output, to the README.")
12 KiB
hledger
Robust, intuitive plain text accounting
Welcome! This a brief intro to hledger. For a more detailed version, see the home page: https://hledger.org
hledger is lightweight, cross platform, multi-currency, double-entry accounting software. It lets you track money, investments, cryptocurrencies, invoices, time, inventory and more, in a safe, future-proof plain text data format with full version control and privacy.
hledger aims to help both computer experts and regular folks gain clarity in their finances and time management. Though the UIs are basic, hledger can model any accounting situation and provide precise, clear reports. It is reliable, quick, and backed by the highly supportive Plain Text Accounting ecosystem. Using it is an excellent way to learn double entry accounting.
Compared to other PTA apps, hledger is actively maintained, with regular releases, and a strong focus on being easy to use and practical for everyday accounting.
More features:
- Installs easily on unix, mac or windows
- Complete, built-in documentation in multiple formats, beginner videos, tutorials etc.
- Multiple UIs: command-line, terminal, web, mobile, editors/IDEs
- Good at importing and exporting CSV; also outputs text/HTML/JSON/SQL
- A robust, general, well-specified multi-currency accounting engine
- Fast, analysing 25k transactions per second on a macbook air m1
- Accurate to 255 decimal places
- Supports your preferred account names, currencies, number formats
- Inspired by and partly compatible with Ledger CLI; interconvertible with Beancount
- Scriptable by CLI, HTTP or API, with plenty of examples
- Clean Haskell codebase, continually improved since 2007, with $100 regression bounties
- Free software licensed under GPLv3+.
Examples
I use hledger to:
- track income and spending, sometimes with budgets
- see time reports by day/week/month/project
- track reimbursables, invoices and payments
- predict cashflow and account balances
- get accurate numbers for tax filing
- research past events
Here's an example of the journal file format:
2022-01-01 opening balances as of this date
assets:bank:checking $1000
assets:bank:savings $2000
assets:cash $100
liabilities:creditcard $-50
equity:opening/closing balances
2022-01-15 market
expenses:food $50
assets:cash $-50
2022-02-01 GOODWORKS CORP
assets:bank:checking $1000
income:salary $-1000
and some simple reports:
$ hledger bs
Balance Sheet 2022-02-15
|| 2022-02-15
========================++============
Assets ||
------------------------++------------
assets:bank:checking || $2000
assets:bank:savings || $2000
assets:cash || $50
------------------------++------------
|| $4050
========================++============
Liabilities ||
------------------------++------------
liabilities:creditcard || $50
------------------------++------------
|| $50
========================++============
Net: || $4000
$ hledger is --monthly
Income Statement 2022-01-01..2022-02-28
|| Jan Feb
===============++=============
Revenues ||
---------------++-------------
income:salary || 0 $1000
---------------++-------------
|| 0 $1000
===============++=============
Expenses ||
---------------++-------------
expenses:food || $50 0
---------------++-------------
|| $50 0
===============++=============
Net: || $-50 $1000
More examples: https://hledger.org/#how-to-get-started
Sponsors
hledger is brought to you by Simon Michael and 140+ contributors. After enjoying some personal or organisational success with hledger, you might want to become one of the generous sponsors helping to sustain this work. (More info: https://hledger.org/sponsor.html)
Sponsor Simon (project leader)
Organisations sponsoring hledger
Individuals sponsoring hledger
Sponsor specific tasks
