hledger basics tutorial
Clone this wiki locally
- Check your hledger installation
- Locate your journal file with "hledger stats"
- Record a transaction with "hledger add"
- Show transactions with "hledger print"
- Examine your journal file
- A convenience: inferred amounts
- Edit the journal file
- Two spaces
- Unbalanced transactions
- Record a transaction by editing
- Show postings and a running total with "hledger register"
- Show a per-account register report
- Set initial account balances
- Query expressions
- Show accounts and their balances with "hledger balance"
- balance shows the sum of matched posting amounts
Here you can learn hledger (and a little double-entry bookkeeping) by practicing, in small hands-on steps. You'll need:
hledger. Download and install it if you haven't already.
You'll learn the most if you master each step, in order. Most steps give you a task with a clear goal; if not, your task is to run the examples and understand them.
If you get stuck, find a problem, or have feedback, please report it on the IRC channel or mail list, or send a pull request for this page.
Let's get started!
Check your hledger installation
Get a command prompt, and run hledger to check the version. It should be reasonably up to date. These exercises were last tested with this version:
$ hledger --version hledger 1.9
Locate your journal file with "hledger stats"
hledger reads financial transactions from a "journal file" (so named because it represents a General Journal). The default journal file is in your home directory; check its path using the stats command. You should see something like:
$ hledger stats The hledger journal file "/home/YOU/.hledger.journal" was not found. Please create it first, eg with "hledger add" or a text editor. Or, specify an existing journal file with -f or LEDGER_FILE.
Most hledger commands read this file but can not change it; the
web commands can also write it.
stats reports that the file exists, eg because you previously created it, move it out of the way temporarily for these exercises.)
Record a transaction with "hledger add"
Follow the help and use the add command to record your first transaction, an imaginary purchase at the supermarket. We'll go through this in detail. Later you'll learn other ways to enter data.
$ hledger add Creating hledger journal file "/home/YOU/.hledger.journal". Adding transactions to journal file /home/YOU/.hledger.journal Any command line arguments will be used as defaults. Use tab key to complete, readline keys to edit, enter to accept defaults. An optional (CODE) may follow transaction dates. An optional ; COMMENT may follow descriptions or amounts. If you make a mistake, enter < at any prompt to restart the transaction. To end a transaction, enter . when prompted. To quit, enter . at a date prompt or press control-d or control-c. Date [2015/05/25]:
add prompts for each transaction field. The first is the date.
The value in square brackets is the suggested default (today's date). Press enter to accept it.
Description: trip to the supermarket
Transactions have an optional description (a single line of text) to help you understand them.
You can describe the transaction here, or put a payee name, or leave it blank.
trip to the supermarket and press enter.
Account 1: expenses
Transactions have two or more accounts. Keep it simple; just enter
expenses for the first one.
If you're thinking "expenses sounds more like a category": it is, but double entry accounting calls those "accounts", too. A purchase is a transfer of money from an asset account to an expense account. An asset is something you own, like some money in a bank account or in your pocket. Once the money has been "moved" to an expense, you no longer own it, but the increasing balance in the expense account reminds you where it went.
Amount 1: $10
The amount being "moved" to
expenses. In this case 10 US dollars.
Account 2: assets
Next, specify which account the money comes from. Just say
Amount 2 ? [$-10.0]:
Now you're asked for the amount to "move" to or from the
As the default, hledger offers the amount required to "balance" the postings entered so far.
The minus sign indicates the money is moving from this account.
(hledger uses the positive and negative sign instead of accounting's traditional "debit" and "credit" terminology.)
In a balanced transaction, the sum of posted amounts is zero, in other words no money disappears into thin air.
Press enter to accept the default. It has an extra decimal place, but never mind.
Account 3 (or . to finish this transaction): .
. (period) and press enter.
2015/05/25 trip to the supermarket expenses $10 assets $-10.0 Save this transaction to the journal ? [y]:
You are given a chance to review the transaction just entered. Here you see hledger's plain text data format for journal entries: a non-indented YYYY/MM/DD date, space, and description, followed by two or more indented posting lines, each containing an account name, two or more spaces, and an amount. (Account names can contain spaces, so at least two spaces are needed to separate them from the amount.) Press enter.
Saved. Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2015/05/25]: <CTRL-D>
hledger has saved it to the journal file and is ready for the next entry. Press control-d (on Windows, control-c) once to exit.
stats should now report that your journal exists and contains one transaction:
$ hledger stats Main journal file : /home/YOU/.hledger.journal Included journal files : Transactions span : 2015-05-25 to 2015-05-26 (1 days) Last transaction : 2015-05-25 (0 days ago) Transactions : 1 (1.0 per day) Transactions last 30 days: 1 (0.0 per day) Transactions last 7 days : 1 (0.1 per day) Payees/descriptions : 1 Accounts : 2 (depth 1) Commodities : 1 ($)
Show transactions with "hledger print"
The print command shows a tidied-up view of the transaction entries in your journal. Since there's just one so far, you should see:
$ hledger print 2015/05/25 trip to the supermarket expenses $10 assets $-10
Examine your journal file
List and print the journal file (on Windows, use
type and the file path from
$ ls -l ~/.hledger.journal -rw-r--r-- 1 YOU YOU 114 May 25 16:55 /home/YOU/.hledger.journal $ cat ~/.hledger.journal ; journal created 2015-05-25 by hledger 2015/05/25 trip to the supermarket expenses $10 assets
A convenience: inferred amounts
Why is the amount missing from the assets posting above ?
As a convenience to make manual data entry easier, if one amount is missing
hledger infers it so as to balance the transaction ($-10 in this case).
Only one missing amount is allowed in each transaction.
add uses the same convention when it writes an entry.
(To see all such inferred amounts in full, you can use
hledger print -x.)
Edit the journal file
Since the journal file is plain text, you can edit it directly with any text editor. Edit the file and change it to test whether two missing amounts is reported as an error. Eg:
$ emacs ~/.hledger.journal
Remove the expenses amount and save the file. It now looks like this:
2015/05/25 trip to the supermarket expenses assets
hledger: could not balance this transaction (can't have more than one missing amount; remember to put 2 or more spaces before amounts) 2015/05/25 trip to the supermarket expenses assets
All hledger commands expect the journal to be well-formed, and will report an error and exit otherwise.
Notice the last part of that error message: "
... remember to put 2 or more spaces before amounts)".
Another cause of this error is forgetting to put two spaces before the
amount, like this:
2015/05/25 trip to the supermarket expenses $10 ; <- problem: only one space between expenses and $10 assets
Since account names may contain spaces, hledger thinks the first
posting is to an account named "
expenses $10", with a missing
amount. So remember: two or more spaces.
Edit the file to look like this:
2015/05/25 trip to the supermarket expenses $10 assets $10 ; <- deliberate problem: both amounts are positive
Here, we wrote both posting amounts but got the sign wrong on one of them, so they don't add up to zero.
hledger should detect this mistake. Verify it by running some command, eg
$ hledger print hledger: could not balance this transaction (real postings are off by $20) 2015/05/25 trip to the supermarket expenses $10 assets $10
That makes sense. (It calls them "real" postings because there are some other kinds of posting you haven't learned about yet; they aren't important.)
Correct the mistake by adding the minus sign, or just removing the assets amount entirely, and verify
$ hledger print 2015/05/25 trip to the supermarket expenses $10 assets $-10
Record a transaction by editing
Edit the file again and manually add a second purchase transaction. It's often quickest to copy & paste a similar entry, then change it. Make the file look like this:
2015/05/25 trip to the supermarket expenses $10 assets $-10 2015/05/26 forgot the bread expenses $5 assets
The blank line between transactions is customary, though not required.
Test your work with
$ hledger print 2015/05/25 trip to the supermarket expenses $10 assets $-10 2015/05/26 forgot the bread expenses $5 assets $-5
Show postings and a running total with "hledger register"
The register command shows transactions in a different format. More precisely, it shows postings.
Remember, a posting is an increase or decrease of some account by some amount, and a transaction contains two or more of them.
register and compare with the output of
$ hledger register 2015/05/25 trip to the supermarket expenses $10 $10 assets $-10 0 2015/05/26 forgot the bread expenses $5 $5 assets $-5 0
Postings are displayed one per line. The transaction's date and description is displayed only for the first posting in each transaction. Next we see the posted account's name and the amount posted. The final column is a running total of the posted amounts.
Show a per-account register report
Notice how the running total above keeps resetting to 0. This makes sense (since we know each transaction's postings add up to zero) but isn't very useful. The register report is more useful when we restrict it to a subset of postings - say, only the postings within a single account. You can do this by specifying the account name as a command line argument.
Run a register report for the
expenses account. You should see something like the below.
(On POSIX platforms, this command uses the terminal width so the output may look slightly different.
You can force it to look like the below by running
export COLUMNS=80 first:
$ hledger register expenses 2015/05/25 trip to the super.. expenses $10 $10 2015/05/26 forgot the bread expenses $5 $15
Now it's clear that your
expenses balance - ie, the total amount spent - has increased to $15.
assets balance should have dropped accordingly. Check it:
$ hledger register assets 2015/05/25 trip to the super.. assets $-10 $-10 2015/05/26 forgot the bread assets $-5 $-15
Set initial account balances
hledger assumes every account starts with a zero balance,
so in the previous example, we see the withdrawals producing a negative running balance.
assets represents a real-world asset, like your bank checking account, and you want to start tracking it from 2015/05/01 onward, and on that day it contained exactly $500.
To show the real-world account balance, edit your journal file and add this transaction at the top:
2015/05/01 set initial assets balance assets $500 equity:opening balances
The other account name doesn't matter too much;
equity:opening balances is conventional.
(You could also use an unbalanced transaction for this if you prefer.)
Now the report looks like this, with an accurate running balance on each date (hledger calls this a historical balance):
$ hledger register 2015/05/01 set initial asset.. assets $500 $500 2015/05/25 trip to the super.. assets $-10 $490 2015/05/26 forgot the bread assets $-5 $485
The account name argument above is an example of a query expression, a search pattern which restricts a report to a subset of the data. In this way you can make very precise queries.
Note that it is a case-insensitive regular expression which matches anywhere inside the account name.
e" would match both
And if you had an account named
other assets, "
assets" would also match that, so to match only the
account you'd need a more precise pattern like "
(In a regular expression
^ means "match at the beginning" and
$ means "match at the end".)
If this doesn't make sense, read a little about regular expressions.
Multiple query arguments are ANDed and ORed together in a fixed way - follow the link for details. Basically queries on the same field are ORed, and queries on different fields are ANDed.
Run the following examples and make sure they make sense, consulting the manual as needed.
Show only transactions whose description ends with "bread":
$ hledger print desc:bread$ 2015/05/26 forgot the bread expenses $5 assets $-5
Show only postings on or after a certain date to an account whose name contains "exp":
$ hledger register date:2015/5/26- exp 2015/05/26 forgot the bread expenses $5 $5
Show accounts and their balances with "hledger balance"
The third of hledger's three core reporting commands is balance. Use it to list all the accounts posted to, and their ending balance. You should see account balances agreeing with the final running total in the register reports above:
$ hledger balance $-15 assets $15 expenses -------------------- 0
The overall total of these balances is also shown. As with other reports, you can use a query expression to select a subset of the data to report on. Eg:
$ hledger balance assets $-15 assets -------------------- $-15
balance shows the sum of matched posting amounts
Here's a balance report based only on the postings dated 2015/5/26:
$ hledger balance date:2015/5/26 $-5 assets $5 expenses -------------------- 0
As you can see from this,
balance does not necessarily report
real-world account balances; rather, it shows the sum of the postings
you have selected. If you're not sure what those are, run a
register report with the same arguments to see them:
$ hledger register date:2015/5/26 2015/05/26 forgot the bread expenses $5 $5 assets $-5 0
You have learned:
a simple plain text notation for recording financial transactions, used by hledger, Ledger and others
what is the journal file, where it is, and how to get statistics on it with
how to record new transactions using
how to record transactions by editing the journal file
what the journal entry for a purchase looks like
how to detect some common errors, by eye or with hledger
how hledger selects data to report on, and how to select by account, description, or date
how to list transactions with
how to list postings and see an account's balance over time with
how to list accounts and their current balance, or the sum of their postings in some period, with