hledger-ui is hledger's TUI (a full-window terminal interface). It's fast, efficient, and a bit more featureful than the web UI. One limitation: on Microsoft Windows, it can only be installed inside WSL. Screenshots below!
$ hledger-ui --version hledger-ui 184.108.40.206
If this fails, check Installing for install and setup tips.
Normally, you start hledger-ui by running
hledger-ui in a terminal.
Any standard terminal app will do, but not a command prompt that
doesn't allow cursor positioning (such as an emacs shell buffer).
(In that case you would see garbage output like
^[(B^[(B──────────── tmp.journal account balances...,
and you would have to press
RETURN to exit.)
For this tutorial, we'll specify a new temporary journal file, to suit the steps below and avoid disturbing any existing data:
$ echo > tmp.journal $ hledger-ui -f tmp.journal
Here, we'll use it to enter a few transactions,
similar to the quick start example.
After each prompt, type the value shown in white and press
Continue entering the values shown in white (
This time, based on the description, hledger has picked a "similar transaction",
which will supply defaults for the following prompts. Eg
That's what we want, so press
RETURN to accept it:
Enter the values for the final transaction (
Note, we don't accept the default for
so the transaction remains unbalanced, and we can continue on,
to enter the third posting:
RIGHT to "drill in" to see the transactions in
assets:checking ("register" screen).
The third column shows the other account(s) involved, abbreviated when necessary.
The last column is the account's running balance:
RIGHT again to see the selected transaction's journal entry ("transaction" screen).
We can see this is transaction number 3 in the journal, and also number 3 of 3 in the
With a lot of accounts, sometimes you want to see less detail.
- (minus) key once to reduce the account depth limit by 1.
expenses:food:groceries subaccount (depth 3) has been hidden,
and the heading says "
to depth 2":
RIGHT to see the register for the
Note, while there are no transactions directly referencing the
the transactions of its subaccount
assets:checking are shown, because we're in tree mode.
(In flat mode, they wouldn't be.
That's what the
T:flat(-subs)/tree(+subs) in the help line is about.):
On a register screen, the
SHIFT-UP keys shrink/expand the time period being shown.
By default, the register shows all of the account's transactions.
SHIFT and press the
DOWN arrow once. Not much has changed,
but now the heading says "
(at least, if you are doing this in the year 2020..).
The report period has shrunk to "the current year":
SHIFT-DOWN again. The next smaller period is "the current month",
and (at least, if you are doing this in March, 2020..)
the heading now says
2020/03, and now we can see that only 2
of the transactions are in March:
When the report period has been shrunk in this way,
SHIFT-RIGHT keys move backward/forward in time.
SHIFT-LEFT now should take you to the previous month (
There are no transactions in this month.
(ignore the columns of dots; it's a display bug):
While the help dialog is open, you can press
to see the hledger-ui user manual in several offline formats
(useful if you can't access the web version).
The formats are: plain text (
p), using your $PAGER for scrolling if possible:
Unix man (
or GNU info (
q to return to hledger-ui.